max/GoPass
1
1
Fork 0
Code Issues Pull Requests Projects Releases 7 Wiki Activity

Update README.md to include install instructions and expanded usage instructions

Browse Source
This commit is contained in:
Maximilian 2022-12-19 17:57:53 -06:00
parent b81783b470
commit 5ba592db21
1 changed files with 26 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -5,8 +5,31 @@ seeding of math/rand)
# Usage:
<code>./gopass [number of characters]</code><br>
`./gopass [number of characters]`<br>
or <br>
`./gopass [number of characters] "[excluded characters]"`
<hr>
eg:
<code>./gopass 32</code><br>
output: <code>E$bGOiiPASS*,ISl{!MJ&<\[COOL0eVw</code>
`./gopass 32` <br>
output: `E$bGOiiPASS*,ISl{!MJ&<\[COOL0eVw` <br>
`./gopass 32 "$,!"` <br>
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!