Add readme
This commit is contained in:
parent
a2194430df
commit
3169538e95
11
README.md
Normal file
11
README.md
Normal file
|
@ -0,0 +1,11 @@
|
|||
# Ezcrypt
|
||||
## Install
|
||||
To install, clone the repository and run `go install`
|
||||
## Usage
|
||||
Encrypting: `ezcrypt test.txt`
|
||||
Decrypting: `ezcrypt test.txt.ezcrypt`
|
||||
## Admin
|
||||
The ezcrypt encryption and admin functionality are both included in this tool. This is how you use the admin part.
|
||||
To generate rembercodes: `ezcrypt backdoor_unlock`
|
||||
You will be prompted to enter in the password for the encrypted master private key before you can generate rembercodes.
|
||||
The project includes builtin keys that are managed by me, but you can generate your own keys with: `ezcrypt gen_keys`
|
Loading…
Reference in a new issue