From ac70ff9f1bd34a1e395333a3b5ea7d0d3b17e5af Mon Sep 17 00:00:00 2001
From: Vuong Tru <trubavuong@gmail.com>
Date: Sat, 22 May 2021 11:30:09 +0700
Subject: [PATCH] docs: update README

---
 README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 58 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c874f1e..10da429 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,65 @@
 
 NodeJS client for [SeaweedFS](https://github.com/chrislusf/seaweedfs)
 
-# Quick start
+## Install
 
 ```
 $ npm install @trubavuong/seaweedfs
 ```
+
+## APIs
+
+### BlockStorage
+
+```
+const { BlockStorage } = require('@trubavuong/seaweedfs');
+```
+
+#### Constructor
+
+```
+const blockStorage = new BlockStorage({
+  endpoint: 'http://localhost:9333',
+});
+```
+
+#### blockStorage.reserve({ count })
+
+```
+const { name } = blockStorage.reserve({
+  count: 10,
+});
+```
+
+#### blockStorage.add({ data })
+
+```
+const { name, size } = blockStorage.add({
+  data: fileData,
+});
+```
+
+#### blockStorage.replace({ data, name })
+
+```
+const { name, size } = blockStorage.replace({
+  name: fid,
+  data: fileData,
+});
+```
+
+#### blockStorage.get({ name })
+
+```
+const fileStream = blockStorage.get({
+  name: fid,
+});
+```
+
+#### blockStorage.delete({ name })
+
+```
+const isDeleted = blockStorage.delete({
+  name: fid,
+});
+```