run verb to generate readme documentation

jonschlinkert · Oct 23, 2018 · 746801c · 746801c
1 parent 98031f4
commit 746801c
Showing 1 changed file with 46 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -57,7 +57,7 @@ randomize('Aa0!', 10);
 
 ### length
 
-> the length of the string to generate
+> The length of the string to generate
 
 **Examples:**
 
@@ -76,6 +76,10 @@ If `length` is left undefined, the length of the pattern in the first parameter
 
 These are just examples, [see the tests](./test.js) for more use cases and examples.
 
+## options
+
+> These are options that can be passed as the third argument.
+
 #### chars
 
 Type: `String`
@@ -116,30 +120,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** |  
-| --- | --- |  
-| 56 | [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) |  
-| 1  | [michaelrhodes](https://github.com/michaelrhodes) |  
+```sh
+$ npm install && npm test
+```
 
-### Building docs
+</details>
+
+<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.)_
 
@@ -149,20 +149,39 @@ 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** |  
+| --- | --- |  
+| 56 | [jonschlinkert](https://github.com/jonschlinkert) |  
+| 6  | [doowb](https://github.com/doowb) |  
+| 4  | [kivlor](https://github.com/kivlor) |  
+| 2  | [realityking](https://github.com/realityking) |  
+| 2  | [ywpark1](https://github.com/ywpark1) |  
+| 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) |  
+| 1  | [michaelrhodes](https://github.com/michaelrhodes) |  
 
 ### Author
 
 **Jon Schlinkert**
 
-* [github/jonschlinkert](https://github.com/jonschlinkert)
-* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
+* [GitHub Profile](https://github.com/jonschlinkert)
+* [Twitter Profile](https://twitter.com/jonschlinkert)
+* [LinkedIn Profile](https://linkedin.com/in/jonschlinkert)
 
 ### License
 
@@ -171,4 +190,4 @@ Released under the [MIT License](LICENSE).
 
 ***
 
-_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.7.0, on August 08, 2018._
+_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on October 23, 2018._