From 5359911c84ccb0e171a9882dda458868c9bbffbb Mon Sep 17 00:00:00 2001 From: MillironX <25492070+MillironX@users.noreply.github.com> Date: Tue, 20 Jul 2021 11:31:10 -0500 Subject: [PATCH] Personalize README.md --- README.md | 39 ++++++++++++++++++++++++++++++--------- 1 file changed, 30 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index ae054d9..a5de8b0 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,55 @@ # Docker Names -An implementation of [docker-names](https://github.com/moby/moby/blob/master/pkg/namesgenerator/names-generator.go) in TypeScript. +An implementation of [docker-names](https://github.com/moby/moby/blob/master/pkg/namesgenerator/names-generator.go) in TypeScript. Forked from . + +## Changes + +1. Added more names of scientists related to + - chemical engineering + - animal breeding + - rumen science + - among others... +2. Changed the delimiter back to an underscore +3. Added an identifier that starts with a date (useful where identifiers have to be sorted chronologically). ## 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. + ### Generate Name ```typescript -import {generateName} from '@criblinc/docker-names' +import {generateName} from '@millironx/docker-names' const dockerName = generateName(); console.log(dockerName); -//Outputs goofy-panini +//Outputs goofy_panini ``` ### Generate Name With Number - ```typescript -import {generateNameWithNumber} from '@criblinc/docker-names' +import {generateNameWithNumber} from '@millironx/docker-names' const dockerName = generateNameWithNumber(); console.log(dockerName); -//Outputs goofy-panini-4 +//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 ``` ## Words @@ -34,7 +57,7 @@ console.log(dockerName); The words can also be imported from the package if need be. ```typescript -import {left,right} from '@criblinc/docker-names' +import {left,right} from '@millironx/docker-names' console.log(left); @@ -43,6 +66,4 @@ console.log(left); console.log(right) //Outputs [albattani,allen, etc...] - - ```