datalore/random-username-generator
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

change(README): Added description for format and parameters

Browse Source
This commit is contained in:
datalore
2024-04-16 21:12:57 +02:00
parent 0467f94fd3
commit d501746f68
1 changed files with 16 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -1,3 +1,18 @@
# random-username-generator
Generates random usernames.
Generates random usernames using the Mersenne Twister 19937 engine.
## Format
The generated usernames have the format `<random letters><random numbers>`, with count of numbers and total length being randomly generated within a certain range, which can be adjusted via command line arguments.
## Parameters
The following parameters can be specified:
- `--min-char` : The minimum number of characters (including numbers) (default: 8)
- `--max-char` : The maximum number of characters (including numbers) (default: 10)
- `--min-num` : The minimum number of digits (default: 0)
- `--max-num` : The maximum number of digits (default: 4)
- `--count` : How many usernames should be generated (default: 1)
- `--seed` : String used as seed sequence. If not defined, system time will be used instead.