Silly Animals
This package allows you to create unique identifiers using animal names with descriptors, such as adjectives and adverbs. It is ideal for creating interesting random URLs, filenames, and IDs.
Installation
npm install silly-animals
Usage example
const sillyAnimals = require("silly-animals");
// if no paramters are passed it returns a string in
// the form "{{adj}} {{adv}} {{n}}" i.e. "silly stuck panther"
let result = sillyAnimals();
// To create a custom template, use {{type}} where you want
// random words. There are current three word types
// {{adj}} - an adjective
// {{adv}} - an adverb
// {{n}} - a noun, always an animal
let customResult = sillyAnimals("{{adj}} {{adj}} {{n}}");
// example output: unpleased chiefly lapwing
Development setup
Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.
npm install
Release History
- 1.0.0 initial release
- 1.0.1 Added default template and removed uneeded dependency
Meta
Rane Wallin – @rane_wallin
Distributed under the MIT license. See LICENSE
for more information.
Contributing
- Fork it (https://github.com/RaneWallin/silly-animals/fork)
- Create your feature branch (
git checkout -b feature/fooBar
) - Commit your changes (
git commit -am 'Add some fooBar'
) - Push to the branch (
git push origin feature/fooBar
) - Create a new Pull Request