foobar-ipsum
About
foobar-ipsum is a lightweight, universal javascript module for generating scaffolding text.
Usage
To install via NPM:
npm install foobar-ipsum
For a quick start using jsdelivr:
foobar-ipsum supports the following options:
size.sentence
;int
15 : Length of a sentence (words).
size.paragraph
;int
3 : Length of a paragraph (sentences).
dictionary
;array
: List of words for generator to pool from.
Generator API
word()
: Generate a random word given the provided dictionary.
sentence(size = null)
: Create a random sentence given the provided dictionary and sentence bounds.
paragraph(size = null, eoc = null)
: Create a random paragraph given the provided dictionary and paragraph bounds.
The generator can be used like so:
const generator = let word = generatorlet sentence = generatorlet paragraph = generator
Contributors
- John Nolette (john@neetgroup.net)
Fork Contributors
- Nickolas Kenyeres
- Marco Biedermann
- Martin Grandrath
- Florian Wendelborn
- Melvin Tiong
Contributing guidelines are as follows,
-
Any new features must include either a unit test, e2e test, or both.
-
Branches for bugs and features should be structued like so,
issue-x-username
. -
Before putting in a pull request, be sure to verify you've built all your changes.
Travis will build your changes before testing and publishing, but bower pulls from this repository directly.
-
Include your name and email in the contributors list.
Copyright (c) 2017 John Nolette Licensed under the MIT license.