38 lines
708 B
Plaintext
38 lines
708 B
Plaintext
### Generates human readable ID strings by chaning common short words of the english language. ###
|
|
|
|
Using words (instead of numbers) to identify datasets provides various advantages when humans are involved. `human-id` generates word ids from a pool of 10 006 400 unique IDs.
|
|
|
|
No dependencies.
|
|
|
|
## Examples
|
|
|
|
- FortyGhostsTalk
|
|
- CalmPanthersDream
|
|
- TastyRocksSparkle
|
|
- HealthyCowsSmile
|
|
- AfraidWallsExist
|
|
- StrangeCarsRush
|
|
- TwoKangaroosSing
|
|
- HappyDolphinsJump
|
|
|
|
## Install
|
|
|
|
```
|
|
$ npm install --save human-id
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
const humanId = require('human-id');
|
|
|
|
// RareGeckosJam
|
|
humanId();
|
|
|
|
// rare-geckos-jam
|
|
humanId({
|
|
separator: '-',
|
|
capitalize: false
|
|
});
|
|
```
|