about summary refs log tree commit diff stats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README30
1 files changed, 25 insertions, 5 deletions
diff --git a/README b/README
index 8952f95..5d08259 100644
--- a/README
+++ b/README
@@ -1,17 +1,18 @@
 ayu (あゆ)
 ===
 
-Not-so standard unix password manager, written in (mostly) posix shell
+Not-so standard unix password manager, written in (mostly) posix shell (~90 LoC)
 Uses <https://age-encryption.org> as back-end, and tree(1) to list contents of the password store
 
 Caveats
 -------
 
 For the utility to work, you have to generate your own keypair with age-keygen(1)
-The private key should be placed as ~/.config/ayu/sec.age and the public key should be placed as ~/.config/ayu/pub.age
+The private key should be placed as ~/.ayu/public_key and the public key should be placed as ~/.ayu/public_key
 
-e.g. age-keygen -o ~/.config/ayu/sec.age and the output should be copied into the public key file.
+e.g. age-keygen -o ~/.ayu/private_key && age-keygen -y ~/.ayu/private_key > ~/.ayu/public_key
 
+Store is located by default on ~/.ayu-store/
 
 Anti-features
 -------------
@@ -19,10 +20,29 @@ Anti-features
 1) built-in integration with Git
 2) built-in automatic keypair generation
 
-neither of those are included and probably will never be. 
+Neither of those are included and probably will never be.
 Just use the CLI tools by themselves, lol.
 
+
+Dependencies
+-------------
+
+1) age(1), duh!
+2) mandoc (documentation)
+3) tree
+4) xclip (optional)
+
+
+Related software
+----------------
+
+[angou]: <https://gt.kalli.st/shokara/angou>
+[pa]: <https://github.com/biox/pa>
+[page]: <https://github.com/e-zk/page>
+[pass]: <https://passwordstore.org>
+
+
 License
 -------
 
-Discordian Public License, otherwise, MIT
+Discordian Public License