From 5ba592db218425ec0708ce53df7d1be1d2368e2a Mon Sep 17 00:00:00 2001 From: Maximilian Date: Mon, 19 Dec 2022 17:57:53 -0600 Subject: [PATCH] Update README.md to include install instructions and expanded usage instructions --- README.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0f6837a..8884739 100644 --- a/README.md +++ b/README.md @@ -5,8 +5,31 @@ seeding of math/rand) # Usage: -./gopass [number of characters]
+`./gopass [number of characters]`
+or
+`./gopass [number of characters] "[excluded characters]"`
eg: -./gopass 32
-output: E$bGOiiPASS*,ISl{!MJ&<\[COOL0eVw \ No newline at end of file +`./gopass 32`
+output: `E$bGOiiPASS*,ISl{!MJ&<\[COOL0eVw`
+`./gopass 32 "$,!"`
+output: `EYbGOiiPASS*2ISl{?MJ&<\[COOL0eVw` <- note the excluded characters are not present in the output + +# How to install/use for Windows: + +1. Download Windows binary, it may be helpful to simply rename it to "gopass.exe" (make sure to add .exe, this won't + need to + be typed to execute the file from the CLI, but it is required for Windows to recognize the binary) to keep + commands shorter. +2. Move the file to your `C:\Users\[Username]` directory +3. Opening the console *without* Administrator privileges will put you in the directory mentioned above by default +4. Now type `gopass [number of characters]` (Ex. `gopass 64`) to generate a new password! + +# How to install/use for Linux: + +1. Download Linux binary, it may be helpful to simply rename it to "gopass" to keep commands shorter. +2. Move the file to your home directory. +3. `chmod +x gopass` if necessary +3. Opening your terminal should put you in your home directory by default, if not, just type `cd` to get sent back to + home. +4. Now type `./gopass [number of characters]` (Ex. `./gopass 64`) to generate a new password! \ No newline at end of file