Add brief configuration section to README
authorSiraaj Khandkar <siraaj@khandkar.net>
Tue, 23 Mar 2021 14:49:33 +0000 (10:49 -0400)
committerSiraaj Khandkar <siraaj@khandkar.net>
Tue, 23 Mar 2021 14:49:33 +0000 (10:49 -0400)
README.md

index 1daf22d..4ad9649 100644 (file)
--- a/README.md
+++ b/README.md
@@ -27,6 +27,17 @@ instructions
 ### installation
 `make build && make install` will build and copy `tt` binary into `$PREFIX/bin`.
 
+### 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
 Download feeds from the Internet:
 `tt d (FOLLOW-FILE)`
@@ -34,6 +45,12 @@ Download feeds from the Internet:
 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
+```
+
 See the rest of the usage options:
 `tt -h`
 
This page took 0.029125 seconds and 4 git commands to generate.