From 8fc9c39c3f38aa58a006d404b4b44e12e876eec1 Mon Sep 17 00:00:00 2001 From: Keith Irwin Date: Sat, 24 Feb 2018 23:58:41 +0000 Subject: [PATCH] Rewrote readme --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 32a61aa..44e220c 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,10 @@ # mocha-froth -###### v0.2.2 -[Keith Irwin](https://keithirwin.us/) - [![Build Status](https://travis-ci.org/keith24/mocha-froth.svg?branch=master)](https://travis-ci.org/keith24/mocha-froth) [![Coverage Status](https://coveralls.io/repos/github/keith24/mocha-froth/badge.svg?branch=master)](https://coveralls.io/github/keith24/mocha-froth?branch=master) Fuzzer for mocha testing. Or any javascript testing suite, really. This package provides a function that returns an array of random strings. You know, a [fuzzer](https://en.wikipedia.org/wiki/Fuzzer). + ## Installation ```sh @@ -41,6 +39,9 @@ opt = { } ``` +mocha-froth will return an array of strings you can use to test your code. + + ### Examples Create ten random strings, each up to twenty characters (default): @@ -58,11 +59,13 @@ console.log( froth(5,10) ) ``` Same as above, but without foreign characters: + ```javascript console.log( froth(5,10,{foreign:false}) ) // [ 'VP"""t¬mK²', '²L6)>\r\nV', 'v,→“', '*e8', '→' ] ``` + ## Testing ```sh