From: Siraaj Khandkar <siraaj@khandkar.net>
Date: Tue, 23 Mar 2021 14:49:33 +0000 (-0400)
Subject: Add brief configuration section to README
X-Git-Tag: 0.15.0~5
X-Git-Url: https://git.xandkar.net/?a=commitdiff_plain;h=0b9f3c2cc3af334f88a7a7ce380d786bebae0760;p=tt.git

Add brief configuration section to README
---

diff --git a/README.md b/README.md
index 1daf22d..4ad9649 100644
--- 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`