https://github.com/starryinternet/threewords
https://github.com/starryinternet/threewords
Last synced: 12 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/starryinternet/threewords
- Owner: StarryInternet
- License: mit
- Created: 2017-08-04T18:45:47.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-08-05T01:12:29.000Z (almost 9 years ago)
- Last Synced: 2025-06-29T05:46:36.617Z (12 months ago)
- Language: JavaScript
- Size: 22.5 KB
- Stars: 9
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
threewords
===
[](https://travis-ci.org/StarryInternet/threewords)
Generate deterministic, human-readable names for things.
### Installing
```
npm install --save threewords
```
### Usage
#### Generate from string:
```js
const threewords = require('threewords');
// stable and deterministic (same result every time)
threewords('foo@bar.com'); // defeated-ridiculous-family
threewords('foo@bar.com'); // defeated-ridiculous-family
```
#### Generate random:
```js
const threewords = require('threewords');
// totally random
threewords.random(); // obeisant-voiceless-unit
threewords.random(); // grand-verbal-collaborator
```
#### CLI from string:
```
threewords foo@bar.com
# defeated-ridiculous-family
```
#### CLI random
```
threewords
# obeisant-voiceless-unit
```