From d501746f68ed8ee14911250e67e9efab9b96df5a Mon Sep 17 00:00:00 2001 From: datalore Date: Tue, 16 Apr 2024 21:12:57 +0200 Subject: [PATCH] change(README): Added description for format and parameters --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fe442a4..bdcf108 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,18 @@ # random-username-generator -Generates random usernames. \ No newline at end of file +Generates random usernames using the Mersenne Twister 19937 engine. + +## Format + +The generated usernames have the format ``, 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.