From 6ff54f6a0d5860628ca81abd3c41aa26210ca55f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=91=93=E5=96=B5=E9=85=B1?= <i@iotcat.me>
Date: Fri, 17 Jul 2020 13:51:39 +0800
Subject: [PATCH] Update README.md

---
 README.md | 50 +++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 49 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 07f9a49..286bec2 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,49 @@
-# sentence-generator
\ No newline at end of file
+# sentence-generator
+
+## Quick Start
+
+### cli tools
+
+```sh
+$ npm i -g mksec
+```
+
+### Use in your project
+
+```sh
+$ npm i mksec
+```
+
+## cli
+
+
+### Generate sentences by word
+```sh
+$ mksec g [word]
+```
+
+### Generate one sentence by word
+```sh
+$ mksec o [word]
+```
+
+### Generate sentences by word list file
+```sh
+$ mksec f [file]
+```
+
+
+## Use as lib
+
+```js
+const mksec = require('mksec');
+
+(async ()=>{
+  console.log(await mksec({
+    word: 'Your word',
+    //url: 'optional api url'
+  }));
+})()
+```
+
+