Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 863 Bytes

README.md

File metadata and controls

48 lines (33 loc) · 863 Bytes

threewords

Build Status

Generate deterministic, human-readable names for things.

Installing

npm install --save threewords

Usage

Generate from string:

const threewords = require('threewords');

// stable and deterministic (same result every time)
threewords('[email protected]'); // defeated-ridiculous-family
threewords('[email protected]'); // defeated-ridiculous-family

Generate random:

const threewords = require('threewords');

// totally random
threewords.random(); // obeisant-voiceless-unit
threewords.random(); // grand-verbal-collaborator

CLI from string:

threewords [email protected]
# defeated-ridiculous-family

CLI random

threewords
# obeisant-voiceless-unit