Switch branches/tags
Nothing to show
Find file History
Pull request Compare This branch is 12 commits behind masondesu:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
Readme.md
index.js
package.json
word-key-0.0.1.tgz

Readme.md

#Word-Key

###Super simple random key generation

This module is designed to make generating memorable, random keys a breeze.

##Usage

  • module.getKey() : returns a string of five words from a generic word bank separated by dashes. (Ex: 'three-four-boop-click-one')
  • module.getKey(3) : returns a string of three words from a generic word bank separated by dashes. (Ex: 'five-beep-four')
  • module.getKey(3, ['dragon', 'fairy', 'werewolf']) : returns a string of three words from the given array of mythological creatures separated by dashes (Ex: 'fairy-fairy-werewolf')
  • module.getKey(4, ['dragon', 'fairy', 'werewolf'], '*!') : returns a string of four words from the given array of mythological creaturs separated by "!". (Ex: 'dragon!fairy*!dragon*!werewolf')