From b1d825fe5144a8cc3df0511bc331c7276ffe18cd Mon Sep 17 00:00:00 2001 From: Nicco Date: Thu, 6 Feb 2020 10:12:35 +0100 Subject: [PATCH 1/4] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index bd27537..b05f5d5 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,10 @@ Username generator. Fully typed, simple and customizable. The lists are taken from [this repo](https://github.com/imsky/wordlists) and automatically converted into json by `./generate/wordlist.js` +Icons made by Smashicons from www.flaticon.com + +## 🕹 [Interactive Demo](https://cupcakearmy.github.io/canihazusername/) + ## 🏗 Install ```bash From 3880e0f27abecdd3a82bfb0883d659c22db00f85 Mon Sep 17 00:00:00 2001 From: Nicco Date: Thu, 6 Feb 2020 10:14:36 +0100 Subject: [PATCH 2/4] Update README.md --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b05f5d5..f0fcf83 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Username generator. Fully typed, simple and customizable. The lists are taken from [this repo](https://github.com/imsky/wordlists) and automatically converted into json by `./generate/wordlist.js` -Icons made by Smashicons from www.flaticon.com +![logo](./docs/logo.svg) ## 🕹 [Interactive Demo](https://cupcakearmy.github.io/canihazusername/) @@ -182,3 +182,8 @@ const username = generate('{age|cats|...}') - programming - thought - web + +## 🙏 Credits + +- Wordlist https://github.com/imsky/wordlists +- Icons made by Smashicons from www.flaticon.com From 87e777afcf5977a8e454e8ccd8fd6cc1fea926c1 Mon Sep 17 00:00:00 2001 From: Nicco Date: Thu, 6 Feb 2020 10:15:10 +0100 Subject: [PATCH 3/4] Update README.md --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index f0fcf83..04ad7a4 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@ -# canihazusername +![logo](./docs/logo.svg) Username generator. Fully typed, simple and customizable. The lists are taken from [this repo](https://github.com/imsky/wordlists) and automatically converted into json by `./generate/wordlist.js` -![logo](./docs/logo.svg) - ## 🕹 [Interactive Demo](https://cupcakearmy.github.io/canihazusername/) ## 🏗 Install From 2c4375a338739f1b4cc3a168ab8368d3a6744c97 Mon Sep 17 00:00:00 2001 From: Nicco Date: Thu, 6 Feb 2020 10:17:14 +0100 Subject: [PATCH 4/4] Update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 04ad7a4..17e49b1 100644 --- a/README.md +++ b/README.md @@ -42,9 +42,11 @@ This will build a combined list and choose at random between all those words. ```typescript import { generate } from 'canihazusername' -const username = generate('{age|cats|...}') +const username = generate('{quantity|age|cats|}') ``` +This example will choose a random word between the `quantity`, `age` and `cats` list. + ## 🗂 Lists - age