0.0.1 • Published 10 years ago

totemize v0.0.1

Weekly downloads
34
License
-
Repository
github
Last release
10 years ago

totemize Build Status NPM version

An random generator of an adjective and a noun for release name or mnemonic process name

Installation

Global npm install to use command line tool:

$ npm install -g totemize

Or to use totemize api in you project:

$ npm install --save totemize

Command line

Example:

# Simple usage
$ totemize
Didactic Bear

## See options below
$ totemize -s '-'
Didactic-Bear

# Example with git to create a random tag name
$ git tag 0.4.2 -m "$(totemize)"

Usage:

$ totemize -h

  Usage: totemize [options]

  Options:

    -h, --help                output usage information
    -V, --version             output the version number
    -a, --adjectives <file>   An file that export an array of adjectives
    -n, --nouns <file>        An file that export an array of nouns
    -s, --separator <string>  A string to dissociate adjective and noon (default: space)

API

Example:

var totemize = require('totemize')

console.log(totemize());
// Output: "Propitious Panda"

Customize:

var totemize = require('totemize')


var custom  = totemize({
  adjectives: ['foo'],
  nouns:      ['bar'],
  separator:  '-'
})
// custom => "Foo-Bar"

License

The MIT License