Fixed readme markdown
parent
c33bcbfadc
commit
763f3297f7
|
@ -20,9 +20,10 @@ const froth = require('mocha-froth')
|
||||||
```
|
```
|
||||||
|
|
||||||
Use the syntax `froth(num, max, opt)`where:
|
Use the syntax `froth(num, max, opt)`where:
|
||||||
*num* is the number of strings generated
|
|
||||||
*max* is the maximum string length
|
* *num* is the number of strings generated
|
||||||
*opt* is an object of options for characters to include
|
* *max* is the maximum string length
|
||||||
|
* *opt* is an object of options for characters to include
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
opt = {
|
opt = {
|
||||||
|
@ -37,7 +38,7 @@ opt = {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
## Examples
|
### Examples
|
||||||
|
|
||||||
Create ten random strings, each up to twenty characters (default):
|
Create ten random strings, each up to twenty characters (default):
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue