about summary refs log tree commit diff stats
path: root/README
diff options
context:
space:
mode:
authorNova li Gensokyo <novaburst@kalli.st>2021-12-06 10:57:05 +0000
committerNova li Gensokyo <novaburst@kalli.st>2021-12-06 10:57:05 +0000
commite7eeaeacd280d6cc77d49bd2f4f21b9abdaf79c9 (patch)
treefcd0153784e9d06496984013c7875ba26a91ae09 /README
parent7495ce54348be1c9524569f8895de538c5c4bf16 (diff)
downloadayu-e7eeaeacd280d6cc77d49bd2f4f21b9abdaf79c9.tar.gz
Hypothesize and test.
Diffstat (limited to 'README')
-rw-r--r--README24
1 files changed, 24 insertions, 0 deletions
diff --git a/README b/README
index d286406..97ffcd9 100644
--- a/README
+++ b/README
@@ -8,3 +8,27 @@ Dependencies
 
 - age
 - tree
+
+
+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/age.key and the public key should be placed as ~/.ayu/.age-id
+
+e.g. age-keygen -o ~/.config/ayu/age.key and the output should be copied into the public key file.
+
+
+Anti-features
+-------------
+
+1) built-in integration with Git
+2) built-in automatic keypair generation
+
+neither of those are included and probably will never be. 
+Just use the CLI tools by themselves, lol.
+
+License
+-------
+
+Discordian Public License