Skip to content

Commit

Permalink
v1.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
bubkoo committed Apr 24, 2016
1 parent d1738e1 commit 3c0c2a7
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ var randomLorem = require('random-lorem');
// - randomLorem(min, max);
```

By default, return a string with the length between `1` and `20`:
By default, return a string with the length between `2` and `20`:

```js
randomLorem();
// => ksifopmelq
```

Can optionally provide the max length:
Can optionally provide the max length, and the length should be between `2` and `max`:

```js
randomLorem(8);
Expand All @@ -54,7 +54,7 @@ randomLorem(5, 5); // should only have 5 chars.

**Note**: these min and max are **inclusive**, so they are included in the range.

This means `randomLorem(2, 4)` return the lorem would have a length either `2`, `3` or `4`.
This means `randomLorem(2, 4)` would return a lorem with a length either `2`, `3` or `4`.


## Related
Expand All @@ -64,6 +64,7 @@ This means `randomLorem(2, 4)` return the lorem would have a length either `2`,
- [random-sentence](https://github.com/mock-end/random-sentence) - Return a random sentence.
- [random-paragraph](https://github.com/mock-end/random-paragraph) - Return a random paragraph.


## Contributing

Pull requests and stars are highly welcome.
Expand Down

0 comments on commit 3c0c2a7

Please sign in to comment.