1 | # label [![Build Status](https://travis-ci.org/eliasgs/label.png?branch=master)](https://travis-ci.org/eliasgs/label)
|
2 | Inspired by Heroku, ``label`` generates random two word identifiers.
|
3 |
|
4 | ## Install
|
5 |
|
6 | ```bash
|
7 | npm install label
|
8 | ```
|
9 |
|
10 | ## CLI
|
11 |
|
12 | ```bash
|
13 | usage: label [--delimiter|-d <delimiter>] [--capitalize|-c]
|
14 | [--help|-h] [--version|-v]
|
15 | ```
|
16 |
|
17 | ## Usage examples
|
18 |
|
19 | ```javascript
|
20 | var label = require('label');
|
21 |
|
22 | var title = label.generate();
|
23 | console.log(title); // light beard
|
24 |
|
25 | var random = label.generate(true);
|
26 | console.log(random); // Liquid Stream
|
27 |
|
28 | var uri = 'https://' + label.generate(false, '-') + '.example.com/';
|
29 | console.log(uri); // https://intimate-rabbit.example.com/
|
30 | ```
|
31 |
|
32 | ## Note
|
33 |
|
34 | Probability of collision is 0.00007%.
|