update readme

1 files changed, 43 insertions, 0 deletions

diff --git a/README b/README
index 16f870a..cb49f9c 100644
--- a/README
+++ b/README
@@ -2,3 +2,46 @@ mail
 ====
 
 A mail client that works the way I want a mail client to work.
+
+Currently, that only holds for the parts that work, of which there aren't a lot.
+When it's actually usable I'm going to use it full time and not shut up about
+it. Zero shame.
+
+See further down for a list of current and planned features. There's also the
+issue tracker on GitHub for more concrete stuff.
+
+Requirements
+------------
+
+- Rust >= 1.38.0 (might change, let me know if it has)
+- Notmuch and notmuch database
+
+I build with latest rust stable (currently 1.51.0), but this might change
+should I find something in nightly that I want to play around with.
+
+Regarding operating systems, the constraining factor is notmuch and/or the
+notmuch bindings. I use Linux (Arch btw) but I don't see any reason for it not
+to work on other Linux distributions or even BSD and macOS.
+
+Current features
+----------------
+
+- List all tag:inbox
+  - Remove a tag:inbox (without visual confirmation)
+- List all tag:sent
+- Short-lived database locks so you can test in real time with emacs (owo) in
+  split-screen
+
+Future features (minimal)
+-------------------------
+
+- Open and read (only text/plain, text/html can go bother someone else)
+- Write and send (probably via $EDITOR and msmtp)
+- Search
+
+Future features (maximal)
+-------------------------
+
+- Parse and show text/html
+- Reply/forward
+- Actual thread-view for messages