X-Git-Url: https://git.xandkar.net/?a=blobdiff_plain;f=README.md;fp=README.md;h=4ad96495d8d58476a30a8a8cf9db9392c49df85a;hb=0b9f3c2cc3af334f88a7a7ce380d786bebae0760;hp=1daf22db1497a8a5edd5bec768d7bc7821502c27;hpb=54c0807b7619023c7fbb28488459e7961d52ec27;p=tt.git 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 `` and `` 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`