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' + })); +})() +``` + +