get ready for making a package

1 files changed, 39 insertions, 0 deletions

diff --git a/README.org b/README.org
new file mode 100644
index 0000000..848c5cb
--- /dev/null
+++ b/README.org
@@ -0,0 +1,39 @@
+* kasi.el --- emacs secrets manager ("veil"/"conceal" in Esperanto)
+A simple password manager written in Emacs Lisp (rewrite of previous
+[[https://git.vineetk.net/kasi/][kasi]] in POSIX shell).
+
+** Dependencies
+- Emacs
+- Any package that provides transparent decryption of files on
+  opening, such as [[https://github.com/anticomputer/age.el][age.el]] or built-in gnupg
+
+** Configuration
+You can set the base directory that contains your files via the custom
+variable =kasi-dir=.
+
+The password files themselves are stored under =kasi-dir= like so and
+listed via =*/*= wildcard:
+#+begin_src
+  category1/
+  - file1
+  - file2
+  category2/
+  - file1
+  - file2
+#+end_src
+
+** File Format
+For ease of parsing, the decrypted password files are S-expressions of
+the following format:
+#+begin_src lisp
+  ((password "redacted")
+   (username "coolname")
+   (email "bob@example.org")
+   (totp "base32string")
+   (extra-notes "other stuff to encrypt"))
+#+end_src
+
+** Never Asked Questions (NAQ)
+*** Why should I use this over any other password manager?
+Don't. For a serious answer, it's because this uses S-expressions for
+the password format.