Add more installation details

[tt.git] / README.md

diff --git a/README.md b/README.md
index 4801607..6d2a855 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,26 @@
-![Screenshot](screenshot.jpg)
+tt
+==
+A more-unixy [twtxt](https://github.com/buckket/twtxt) client.
+
+Doesn't force you to maintain a master "following" file (the way Twitter does),
+but let's you point it to any follow-file every time it runs.
+
+This means unlimited possibilities for ad-hoc, interesting filtering
+combinations. Especially when paired with
+[process substitution](https://en.wikipedia.org/wiki/Process_substitution).
+
+![Screenshot](screenshot-multi.jpg)
+
+instructions
+------------
+
+### requirements
+[Racket](https://download.racket-lang.org/)
+
+### installation
+1. Run `make install` or `raco pkg install`
+2. Add `$HOME/.racket/7.9/bin` to your `$PATH`
+   (replacing `7.9` with whatever version you have installed)
+
+### usage
+`tt (FOLLOW-FILE)`