Add description and instructions
authorSiraaj Khandkar <siraaj@khandkar.net>
Wed, 18 Nov 2020 15:40:05 +0000 (10:40 -0500)
committerSiraaj Khandkar <siraaj@khandkar.net>
Wed, 18 Nov 2020 15:40:05 +0000 (10:40 -0500)
README.md

index 453f2c6..8bf33c3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,24 @@
+tt
+==
+A more-unixy 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)
 ![Screenshot](screenshot-multi.jpg)
+
+instructions
+------------
+
+### requirements
+[Racket](https://download.racket-lang.org/)
+
+### installation
+`make install` or `raco pkg install`
+
+### usage
+`tt (FOLLOW-FILE)`
This page took 0.034554 seconds and 4 git commands to generate.