3c8630d2821e1208b4644c4d8cf13d8c0ff57193
[tt.git] / 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 1. Run `make install` or `raco pkg install`
29 2. Add `$HOME/.racket/7.9/bin` to your `$PATH`
30 (replacing `7.9` with whatever version you have installed)
31
32 ### usage
33 Download feeds from the Internet:
34 `tt d (FOLLOW-FILE)`
35
36 Read your timeline:
37 `tt r (FOLLOW-FILE)`
38
39 See the rest of the usage options:
40 `tt -h`
41
42 `tt <command> -h`
43
44
45 notes
46 -----
47
48 ### LWW downloads
49 Downloaded timelines are stored in `~/.tt/cache/<SHA1_OF_URI>`, but no attempt
50 is made to preserve the previously-downloaded messages - each download
51 overrites the previous. One of the implications is that authors can edit/delete
52 history without you noticing.
This page took 0.069737 seconds and 3 git commands to generate.