word-forward

JavaScript random English word and text generation

Overview

This module generates a random English word from a custom dictionary. Word selection can be filtered by word type, with an internal scoring system determining the more common usages of the word. This logic hopes to produce more realistic outcomes while providing elements of randomness to assist with content generation.

Installation

npm

npm install word-forward -S

bower

bower install word-forward -S

Tests

grunt - run all dev modules

npm test - run mocha tests

npm run cover - run istanbul code coverage

Code Coverage

Code coverage is maintained using Istanbul with Coveralls reporting.

Continuous Integration

Continuous integration provided by Travis CI.

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

Community

Updates and discussions about this module can be found @symBrendan on Twitter.

Versioning

For transparency into a common release cycle to strive toward maintaining backward compatibility, word-forward is maintained under the Semantic Versioning guidelines.

Creating a New Version

The following commands will create a new version of the module, automatically create a new tag with the same value as the version, push the tags to the remote, and, finally, push the code to the remote.

npm version patch

git push --tags

git push

npm publish

Creator

Brendan Conrad

• https://twitter.com/symBrendan

License

This project is licensed under the terms of the MIT license.