Sort discovered peer lists

[tt.git] / README.md

diff --git a/README.md b/README.md
index c8a62af..830d08c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -22,22 +22,55 @@ instructions
 ------------
 
 ### requirements
+
+#### manual
 [Racket](https://download.racket-lang.org/)
 
+#### package manager
+- Void Linux: `xbps-install racket`
+- Debian: `apt install racket`
+
 ### 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)
+`make build && make install` will build and copy `tt` binary into
+`$PREFIX/bin`, where `$PREFIX` defaults to `$HOME`.
+
+### configuration
+Put your `<nick>` and `<uri>` into `~/.tt/me`. For example, mine is:
+
+```
+$ cat ~/.tt/me
+xandkar https://xandkar.net/twtxt.txt
+```
+It will be used to fill the `User-Agent` header, so that others can tell you're
+reading their twtxts and perhaps read yours. This isn't strictly necessary and
+if omitted, you'll stay anonymous.
 
 ### usage
-`tt (FOLLOW-FILE)`
+Download feeds from the Internet:
+`tt d [FOLLOW-FILE ... ]`
+
+Read your timeline:
+`tt r [FOLLOW-FILE ... ]`
+
+`FOLLOW-FILE` contains lines with space-separated nick and twtxt.txt URI, like:
+
+```
+xandkar https://xandkar.net/twtxt.txt
+```
+
+If omitted, `FOLLOW-FILE` defaults to `~/.tt/peers`.
+
+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.
+Downloaded timelines are stored in `~/.tt/cache/objects/<URL_ENCODED_URL>`, 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.