From 444e4095f04fafbc663324ef139b7d69973d11ed Mon Sep 17 00:00:00 2001
From: Mans Ziesel <mans@mziesel.com>
Date: Sun, 28 Apr 2024 19:27:31 +0200
Subject: [PATCH] update README

---
 README.md | 30 ++++++++++++++++++++----------
 1 file changed, 20 insertions(+), 10 deletions(-)

diff --git a/README.md b/README.md
index bda7d6f..a576654 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,27 @@
 # passgen
-passgen generate passphrases based on wordlists.
+passgen generates passphrases based on wordlists.
 Usage:
 ```
 Usage: passgen [options]
 
 Options:
   -h, --help              Display this help message and exit
-  -s, --short             Use the short EFF wordlist
-  -l, --large             Use the large EFF wordlist (dfault)
-  --camelcase, -cc        Generate passphrase in CamelCase format
-  -p <path>, --path <path>
+  -s, --short             Use the short EFF wordlist (dfault)
+  -l, --large             Use the large EFF wordlist
+  --camelcase, -cc        Generate passphrase in CamelCase format			
+  -wl <path>, --wordlist <path>
                           Use a custom wordlist file located at <path>
-  -wc <count>, --wordcount <count>
-                          Amount of words to use for passphrase
+  -n <count>, -wc <count>, --wordcount <count>
+                          Amount of words to use for passphrase, default = 5
   --separator <seperator> Specify a character to use as a separator between words, default = `-`
 
 Description:
   Generate passphrases based on wordlists.
+
+Examples:
+  passgen -h
+  passgen --short 4
+  passgen -wl /path/to/custom_wordlist.txt --wordcount 4
 ```
 
 example output:
@@ -26,17 +31,22 @@ retrace-choice-litter-dreamt-zipping
 
 This project uses the [EFF's Wordlists for Random Passphrases](https://www.eff.org/deeplinks/2016/07/new-wordlists-random-passphrases) and [PCG random](https://www.pcg-random.org/) to pick random words
 
-Compiling:
-Compile to linux:
+Compiling:   
+Compile for Linux:
 ```
 mkdir build-linux && cd build-linux && cmake .. && make
 ```
 
-Compile to Windows:
+Compile for Windows:
 ```
 mkdir build-windows && cd build-windows && cmake -DCMAKE_TOOLCHAIN_FILE=../mingw-toolchain.cmake .. && make
 ```
 
+Wordlists are embedded using the following command:   
+```
+xxd -i <path> > include/<path>.txt.hpp
+```
+
 Wordlists:
 - https://www.eff.org/files/2016/07/18/eff_large_wordlist.txt
 - https://www.eff.org/files/2016/09/08/eff_short_wordlist_1.txt