cupcakearmy/canihazusername
1
0
Fork 0
mirror of https://github.com/cupcakearmy/canihazusername.git synced 2024-11-16 10:00:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' of https://github.com/CupCakeArmy/canihazusername

Browse Source
This commit is contained in:
cupcakearmy 2020-02-06 10:18:13 +01:00
commit e74d841259
No known key found for this signature in database
GPG Key ID: D28129AE5654D9D9
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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 <a href="https://www.flaticon.com/authors/smashicons" title="Smashicons">Smashicons</a> from <a href="https://www.flaticon.com/" title="Flaticon"> www.flaticon.com</a>