diff --git a/README.md b/README.md index bd27537..17e49b1 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ -# 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` +## 🕹 [Interactive Demo](https://cupcakearmy.github.io/canihazusername/) + ## 🏗 Install ```bash @@ -40,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 @@ -178,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