make angou-age the main angou to be tool-independent

Angou no longer strictly depends on age or gnupg as the encrypt and decrypt
commands are user changeable.

1 files changed, 21 insertions, 2 deletions

diff --git a/README b/README
index 8d20e2c..08521d1 100644
--- a/README
+++ b/README
@@ -5,13 +5,32 @@ A simple password manager written in POSIX shell.
 Dependencies
 ------------
 - POSIX-compliant environment
-- gnupg
+- age, gnupg, or any other utility to {en,de}crypt files
 - tree (for listing all your passwords and their directories)
   - a simple version is available in https://github.com/pyr/tree
     and in OpenBSD's ports
+  - can possibly be replaced with ls if you add ANGOU_LIST in your ~/.profile
 - xsel (for copying password to clipboard, but can be changed to a different
         command with the ANGOU_CLIPBOARD command that accepts stdin)
 
+Configuration
+-------------
+In your ~/.profile or wherever you set environment variables, add something
+like this if you use age:
+export AGE_KEY=/nas/ssh/id_ed25519
+export AGE_PUB=${AGE_KEY}.pub
+export ANGOU_DIR=/nas/angou-age
+export ANGOU_ENCRYPT="age -R $AGE_PUB"
+export ANGOU_DECRYPT="age -d -i $AGE_KEY -o -"
+
+If you use GnuPG, then add:
+export GPG_ID="user@email.tld" # or your key id
+export ANGOU_DECRYPT="gpg -qd"
+export ANGOU_ENCRYPT="gpg -er $GPG_ID -o -"
+
+For some other file encryptor, you'd need to be able to output the encrypted
+file to stdout or change the last line of edit() that runs $ANGOU_ENCRYPT.
+
 Why should I use this over password-store?
 ------------------------------------------
 Don't. For a serious answer, it's because this doesn't depend on bash.
@@ -23,4 +42,4 @@ Set the ANGOU_DIR environment variable to your password store directory.
 Auto-complete
 -------------
 If you use ksh, all you'd have to do is source contrib/autocomplete.ksh in your
-kshrc.
+kshrc.
\ No newline at end of file