Allow providing paths to ring file

2026-03-24 22:56:17 +08:00
parent 7bdc4c21b4
commit 5dae64e981
2 changed files with 52 additions and 14 deletions
@@ -10,8 +10,8 @@ an encryption tool!

 ## usage
 ```sh
-ec-pass  <input file> -p <password> [-o <out>]
-dec-pass <input file> -p <password> [-o <out>]
-ec-key   <input file> [-o <out>]
-dec-key  <input file> [-o <out>]
-```
+ec-pass  <input file> -p <password> [-o <out>]   # generates a password-protected velvet file
+dec-pass <input file> -p <password> [-o <out>]   # decrypts password-protected velvet files
+ec-key   <input file> [-o <out>] [-p <key path>] # generates a 32-byte ring and a velvet file
+dec-key  <input file> [-o <out>] [-p <key path>] # decrypts a velvet file using a ring file. assumes that the ring file shares the same name as the input file, unless a key is supplied with -p
+```