Added information to README
parent
fcf0c0cf7f
commit
94042fcaba
51
README.md
51
README.md
|
@ -2,18 +2,59 @@
|
||||||
###### v0.0.0
|
###### v0.0.0
|
||||||
[Keith Irwin](https://keithirwin.us/)
|
[Keith Irwin](https://keithirwin.us/)
|
||||||
|
|
||||||
Fuzzer for mocha testing.
|
Fuzzer for mocha testing. Or any suite. This package
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
TODO: write instructions
|
```sh
|
||||||
|
npm install mocha-froth
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
TODO: write instructions
|
Import froth into your project
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
const froth = require('mocha-froth')
|
||||||
|
```
|
||||||
|
|
||||||
## Changelog
|
Use the syntax `froth(num, max, opt)`where:
|
||||||
|
*num* is the number of strings generated
|
||||||
|
*max* is the maximum string length
|
||||||
|
*opt* is an object of options for characters to include
|
||||||
|
|
||||||
TODO: change stuff
|
```javascript
|
||||||
|
opt = {
|
||||||
|
// Set to true to include tests with...
|
||||||
|
none: true, // Empty string
|
||||||
|
whitespace: true, // Various whitespace chars
|
||||||
|
quotes: true, // Combinations of quotes
|
||||||
|
backslashing: true, // Combinations of backslashes
|
||||||
|
symbols: true, // Various symbols
|
||||||
|
foreign: true, // Foreign chars
|
||||||
|
alphanumeric: true, // Ordinary letters and numbers
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
Create ten random strings, each up to twenty characters (default):
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
console.log( froth() )
|
||||||
|
// [ '``8\\ёðNàЧ,', 'µ', '\\,нcy', '?O¬ìè¶ſ\r4á%"Е~', '', 'ИôAàяjùgzH%хйf', 'd\r\nïЧо', '«&pcj→ъгPfЬа|h', 'ñgMſииe&?“3ьXî¢òдq<ц', 'Un5tĸ' ]
|
||||||
|
```
|
||||||
|
|
||||||
|
Create five strings up to ten characters:
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
console.log( froth(5,10) )
|
||||||
|
// [ '¢m\'\'\'ý7\'', 'óé€с-', 'фяþnЭOо', '', 'ykUбáФ¿ŷ¢С' ]
|
||||||
|
```
|
||||||
|
|
||||||
|
Same as above, but without foreign characters:
|
||||||
|
```javascript
|
||||||
|
console.log( froth(5,10,{foreign:false}) )
|
||||||
|
// [ 'VP"""t¬mK²', '²L6)>\r\nV', 'v,→“', '*e8', '→' ]
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in New Issue