Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 996 Bytes

README.md

File metadata and controls

33 lines (25 loc) · 996 Bytes

sobriquet

sobriquet is a name generator built in Javascript and based on Markov Chains.

Circle CI npm version codecov

Installation NPM

npm i -g sobriquet

Usage

$ sobriquet swaggy some words -n 1
Random word(s) generated:
dsome

Help documentation

$ sobriquet -h

Options

  --words string[]      List of words injected to the Markov chain
  -n, --number number   Number of words you want to generate       
  -s, --start string    The starting letter                        
  -h, --help            Display the usage of the CLI               

Tests

Tests are run with Jest from Facebook

npm test