tUpdate README - safe - password protected secret keeper
(HTM) git clone git://git.z3bra.org/safe.git
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit 8bda0996fb87386904d05e6aa2b0300155e03312
(DIR) parent 35e97236826a77a6612f6617fefaa8ab6a521fc5
(HTM) Author: Willy Goiffon <dev@z3bra.org>
Date: Tue, 2 Jun 2020 13:44:22 +0200
Update README
Diffstat:
M README | 15 +++++++++++----
1 file changed, 11 insertions(+), 4 deletions(-)
---
(DIR) diff --git a/README b/README
t@@ -19,14 +19,21 @@ Usage
Refer to safe(1) manual page for details and examples.
The below commands are provided as a quick introduction.
- safe -a mysecret < secret.jpg # store a secret
- safe mysecret > secret.jpg # retrieve a secret
- find ${SAFE_DIR} -type f # list existing secrets
+This will store and retrieve a secret from the safe
+
+ safe -a mysecret < secret.jpg
+ safe mysecret > secret.jpg
+
+Secrets being standard files in $SAFE_DIR, you can list them using
+standard tools:
+
+ find ${SAFE_DIR} -type f
Installation
-----
-Edit config.mk if needed, then build with the following command:
+Edit config.mk as needed, then build/install with the following commands:
+ make
make install
Require [libsodium][0].