parent
f8f5e46cc1
commit
6ff54f6a0d
1 changed files with 49 additions and 1 deletions
@ -1 +1,49 @@ |
||||
# 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…
Reference in new issue