UNPKG

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