summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README24
1 files changed, 15 insertions, 9 deletions
diff --git a/README b/README
index 77ddc82..7f54aa8 100644
--- a/README
+++ b/README
@@ -1,23 +1,29 @@
-*- mode: org -*-
-Shroud is a simple password manager with a command line interface.
-The password database is stored as a Scheme s-expression and encrypted
+Shroud is a simple secret manager with a command line interface. The
+password database is stored as a Scheme s-expression and encrypted
with a [[gnupg.org][GnuPG]] key.
+Each secret is indentified by a unique name and may contain an
+arbitrary set of key/value data pairs.
+
* Usage
#+BEGIN_SRC sh
- # Add a new secret
- shroud hide --id=bank-account --username=foobar --password=hackme
+ # Add a new secret:
+ shroud hide bank-account username=foobar password=hackme
+
+ # Edit an existing secret:
+ shroud hide --edit bank-account password=hackmepls
- # Replace an existing secret
- shroud hide --replace --id=bank-account --username=foobar --password=hackmepls
+ # List all secrets:
+ shroud list
- # Show a saved secret
+ # Show all key/value pairs for a saved secret:
shroud show bank-account
- # Show just the password
- shroud show --password bank-account
+ # Show a single value in a secret:
+ shroud show bank-account password
# Delete a secret
shroud remove bank-account