Add TODOs for typed and executable

[tt.git] / README.md

diff --git a/README.md b/README.md
index 453f2c6..3c8630d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1 +1,52 @@
-![Screenshot](screenshot-multi.jpg)
+tt
+==
+A more-unixy [twtxt](https://github.com/buckket/twtxt) client.
+
+[![Build Status](https://travis-ci.org/xandkar/tt.svg?branch=master)](https://travis-ci.org/xandkar/tt)
+
+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).
+
+### long format (default)
+![Screenshot](screenshot-long.jpg)
+
+### short format (CLI option: -s)
+![Screenshot](screenshot-short.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
+Download feeds from the Internet:
+`tt d (FOLLOW-FILE)`
+
+Read your timeline:
+`tt r (FOLLOW-FILE)`
+
+See the rest of the usage options:
+`tt -h`
+
+`tt <command> -h`
+
+
+notes
+-----
+
+### LWW downloads
+Downloaded timelines are stored in `~/.tt/cache/<SHA1_OF_URI>`, but no attempt
+is made to preserve the previously-downloaded messages - each download
+overrites the previous. One of the implications is that authors can edit/delete
+history without you noticing.