README.md

   1 tt
   2 ==
   3 A more-unixy [twtxt](https://github.com/buckket/twtxt) client.
   4
   5 [![Build Status](https://travis-ci.org/xandkar/tt.svg?branch=master)](https://travis-ci.org/xandkar/tt)
   6
   7 Doesn't force you to maintain a master "following" file (the way Twitter does),
   8 but let's you point it to any follow-file every time it runs.
   9
  10 This means unlimited possibilities for ad-hoc, interesting filtering
  11 combinations. Especially when paired with
  12 [process substitution](https://en.wikipedia.org/wiki/Process_substitution).
  13
  14 ### long format (default)
  15 ![Screenshot](screenshot-long.jpg)
  16
  17 ### short format (CLI option: -s)
  18 ![Screenshot](screenshot-short.jpg)
  19
  20
  21 instructions
  22 ------------
  23
  24 ### requirements
  25 [Racket](https://download.racket-lang.org/)
  26
  27 ### installation
  28 `make build && make install` will build and copy `tt` binary into `$PREFIX/bin`.
  29
  30 ### configuration
  31 Put your `<nick>` and `<uri>` into `~/.tt/me`. For example, mine is:
  32
  33 ```
  34 $ cat ~/.tt/me
  35 xandkar https://xandkar.net/twtxt.txt
  36 ```
  37 It will be used to fill the `User-Agent` header, so that others can tell you're
  38 reading their twtxts and perhaps read yours. This isn't strictly necessary and
  39 if omitted, you'll stay anonymous.
  40
  41 ### usage
  42 Download feeds from the Internet:
  43 `tt d (FOLLOW-FILE)`
  44
  45 Read your timeline:
  46 `tt r (FOLLOW-FILE)`
  47
  48 `FOLLOW-FILE` contains lines with space-separated nick and twtxt.txt URI, like:
  49
  50 ```
  51 xandkar https://xandkar.net/twtxt.txt
  52 ```
  53
  54 See the rest of the usage options:
  55 `tt -h`
  56
  57 `tt <command> -h`
  58
  59
  60 notes
  61 -----
  62
  63 ### LWW downloads
  64 Downloaded timelines are stored in `~/.tt/cache/<SHA1_OF_URI>`, but no attempt
  65 is made to preserve the previously-downloaded messages - each download
  66 overrites the previous. One of the implications is that authors can edit/delete
  67 history without you noticing.