update docs, run verb to generate readme

jonschlinkert · Oct 19, 2017 · 553e294 · 553e294
1 parent 4b9cc05
commit 553e294
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 30 deletions.
diff --git a/.verb.md b/.verb.md
@@ -10,8 +10,9 @@ var randomize = require('{%= name %}');
 randomize(pattern, length, options);
 ```
 
-- `pattern` **{String}**: The pattern to use for randomizing
-- `length` **{Object}**: The length of the string to generate
+- `pattern` **{String}**: (required) The pattern to use for randomizing
+- `length` **{Number}**: (optional) The length of the string to generate
+- `options` **{Object}**: (optional) See available [options](#options)
 
 
 ### pattern
@@ -26,10 +27,10 @@ To generate a 10-character randomized string using all available characters:
 
 ```js
 randomize('*', 10);
-//=>
+//=> 'x2_^-5_T[$'
 
 randomize('Aa0!', 10);
-//=>
+//=> 'LV3u~BSGhw'
 ```
 
 * `a`: Lowercase alpha characters (`abcdefghijklmnopqrstuvwxyz'`)

diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # randomatic [![NPM version](https://img.shields.io/npm/v/randomatic.svg?style=flat)](https://www.npmjs.com/package/randomatic) [![NPM monthly downloads](https://img.shields.io/npm/dm/randomatic.svg?style=flat)](https://npmjs.org/package/randomatic) [![NPM total downloads](https://img.shields.io/npm/dt/randomatic.svg?style=flat)](https://npmjs.org/package/randomatic) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/randomatic.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/randomatic)
 
-> Generate randomized strings of a specified length, fast. Only the length is necessary, but you can optionally generate patterns using any combination of numeric, alpha-numeric, alphabetical, special or custom characters.
+> Generate randomized strings of a specified length using simple character sequences. The original generate-password.
+
+Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
 
 ## Install
 
@@ -22,8 +24,9 @@ var randomize = require('randomatic');
 randomize(pattern, length, options);
 ```
 
-* `pattern` **{String}**: The pattern to use for randomizing
-* `length` **{Object}**: The length of the string to generate
+* `pattern` **{String}**: (required) The pattern to use for randomizing
+* `length` **{Number}**: (optional) The length of the string to generate
+* `options` **{Object}**: (optional) See available [options](#options)
 
 ### pattern
 
@@ -37,10 +40,10 @@ To generate a 10-character randomized string using all available characters:
 
 ```js
 randomize('*', 10);
-//=>
+//=> 'x2_^-5_T[$'
 
 randomize('Aa0!', 10);
-//=>
+//=> 'LV3u~BSGhw'
 ```
 
 * `a`: Lowercase alpha characters (`abcdefghijklmnopqrstuvwxyz'`)
@@ -99,27 +102,26 @@ _The order in which the characters are defined is insignificant._
 
 ## About
 
-### Related projects
+<details>
+<summary><strong>Contributing</strong></summary>
 
-* [pad-left](https://www.npmjs.com/package/pad-left): Left pad a string with zeros or a specified string. Fastest implementation. | [homepage](https://github.com/jonschlinkert/pad-left "Left pad a string with zeros or a specified string. Fastest implementation.")
-* [pad-right](https://www.npmjs.com/package/pad-right): Right pad a string with zeros or a specified string. Fastest implementation. | [homepage](https://github.com/jonschlinkert/pad-right "Right pad a string with zeros or a specified string. Fastest implementation.")
-* [repeat-string](https://www.npmjs.com/package/repeat-string): Repeat the given string n times. Fastest implementation for repeating a string. | [homepage](https://github.com/jonschlinkert/repeat-string "Repeat the given string n times. Fastest implementation for repeating a string.")
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
 
-### Contributing
+</details>
 
-Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
+<details>
+<summary><strong>Running Tests</strong></summary>
 
-### Contributors
+Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
 
-| **Commits** | **Contributor** | 
-| --- | --- |
-| 41 | [jonschlinkert](https://github.com/jonschlinkert) |
-| 1 | [TrySound](https://github.com/TrySound) |
-| 1 | [Drag0s](https://github.com/Drag0s) |
-| 1 | [paulmillr](https://github.com/paulmillr) |
-| 1 | [sunknudsen](https://github.com/sunknudsen) |
+```sh
+$ npm install && npm test
+```
+
+</details>
 
-### Building docs
+<details>
+<summary><strong>Building docs</strong></summary>
 
 _(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
 
@@ -129,13 +131,27 @@ To generate the readme, run the following command:
 $ npm install -g verbose/verb#dev verb-generate-readme && verb
 ```
 
-### Running tests
+</details>
 
-Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
+### Related projects
 
-```sh
-$ npm install && npm test
-```
+You might also be interested in these projects:
+
+* [pad-left](https://www.npmjs.com/package/pad-left): Left pad a string with zeros or a specified string. Fastest implementation. | [homepage](https://github.com/jonschlinkert/pad-left "Left pad a string with zeros or a specified string. Fastest implementation.")
+* [pad-right](https://www.npmjs.com/package/pad-right): Right pad a string with zeros or a specified string. Fastest implementation. | [homepage](https://github.com/jonschlinkert/pad-right "Right pad a string with zeros or a specified string. Fastest implementation.")
+* [repeat-string](https://www.npmjs.com/package/repeat-string): Repeat the given string n times. Fastest implementation for repeating a string. | [homepage](https://github.com/jonschlinkert/repeat-string "Repeat the given string n times. Fastest implementation for repeating a string.")
+
+### Contributors
+
+| **Commits** | **Contributor** | 
+| --- | --- |
+| 48 | [jonschlinkert](https://github.com/jonschlinkert) |
+| 2 | [realityking](https://github.com/realityking) |
+| 1 | [TrySound](https://github.com/TrySound) |
+| 1 | [Drag0s](https://github.com/Drag0s) |
+| 1 | [paulmillr](https://github.com/paulmillr) |
+| 1 | [sunknudsen](https://github.com/sunknudsen) |
+| 1 | [faizulhaque-tp](https://github.com/faizulhaque-tp) |
 
 ### Author
 
@@ -151,4 +167,4 @@ Released under the [MIT License](LICENSE).
 
 ***
 
-_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 09, 2017._
+_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on October 19, 2017._