You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
docker-names/README.md

70 lines
1.5 KiB
Markdown

3 years ago
# Docker Names
An implementation of [docker-names](https://github.com/moby/moby/blob/master/pkg/namesgenerator/names-generator.go) in TypeScript. Forked from <https://github.com/criblio/docker-names>.
## Changes
1. Added more names of scientists related to
- chemical engineering
- animal breeding
- rumen science
- among others...
2. Changed the delimiter to an underscore when adding extra data (date or number)
3. Added an identifier that starts with a date (useful where identifiers have to be sorted chronologically).
3 years ago
## Usage
Maybe this stuff will still work? :shrug: I just replaced everything with my name and code, but I personally transpile to JavaScript rather than use TypeScript directly.
3 years ago
### Generate Name
```typescript
import {generateName} from '@millironx/docker-names'
3 years ago
const dockerName = generateName();
console.log(dockerName);
//Outputs goofy-panini
3 years ago
```
### Generate Name With Number
```typescript
import {generateNameWithNumber} from '@millironx/docker-names'
3 years ago
const dockerName = generateNameWithNumber();
console.log(dockerName);
//Outputs goofy-panini_4
```
### Generate Name With Date
```typescript
import {generateNameWithDate} from '@millironx/docker-names'
const dockerName = generateNameWithDate();
console.log(dockerName);
//Outputs 20210720_goofy-panini
3 years ago
```
## Words
3 years ago
The words can also be imported from the package if need be.
```typescript
import {left,right} from '@millironx/docker-names'
3 years ago
console.log(left);
//Outputs [admiring,adoring, etc...]
console.log(right)
//Outputs [albattani,allen, etc...]
```