README

roli

Fantastic names for your projects, groups, users or anything else you want to give a name to.

Install

npm install --save roli

If you need to use it globally as a CLI tool:

npm install -g roli

Use

const roli = require('roli');
const result = roli();

// 'Precious.Declaration'

Use it with options:

const roli = require('roli');
// Custom separator
const result = roli({
  separator: '_'
});

// 'Precious_Declaration'

More options

{
  "case": "upper" || "lower",  // Upper -or lower case the result.
  "separator": ".",  // Separator. Default: .
  "words": 2,        // Number of words. Default: 2
}

CLI use:

gt; roli --separator=_ --words=3

// 'Precious_Declaration_Subject'

Contribute

fork https://github.com/aichholzer/roli/

More ideas for adjectives and nouns (See ./lib/data.json) are always welcome.

License

MIT

Usage no npm install needed!