From 8e68218be8d94511ccaddde546bcd35e3641390c Mon Sep 17 00:00:00 2001
From: stuzer05 <stuzer05@stuzer.link>
Date: Thu, 28 Mar 2024 13:28:17 +0200
Subject: [PATCH] Add readme

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c283e06
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# Password generator
+* can generate multiple passwords at once (separated by \n)
+* can use Cyrillic/Japanese/Chinese character sets
+* uses at least one character from each character set
+
+## Build
+
+```sh
+go build .
+```
+
+## Usage
+
+```sh
+Usage of ./passgen:
+  -L int             length of the generated password (default 16)
+  -S                 use spaces
+  -all               use all character sets
+  -c int             how many passwords to generate (default 1)
+  -l                 use lowercase ascii characters
+  -U                 use uppercase ascii characters
+  -n                 use numbers
+  -s                 use special characters
+  -unicode-cyrillic  use unicode Cyrillic characters
+  -unicode-chinese   use unicode Chinese characters
+  -unicode-japanese  use unicode Japanese characters
+```
\ No newline at end of file