Update README.md

dependabot/npm_and_yarn/y18n-4.0.1
呓喵酱 4 years ago committed by GitHub
parent f8f5e46cc1
commit 6ff54f6a0d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 50
      README.md

@ -1 +1,49 @@
# sentence-generator
# 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'
}));
})()
```

Loading…
Cancel
Save