Add immutability TODO
[tt.git] / README.md
CommitLineData
3773a4cd
SK
1tt
2==
691c20d1 3A more-unixy [twtxt](https://github.com/buckket/twtxt) client.
3773a4cd 4
6df41218
SK
5[![Build Status](https://travis-ci.org/xandkar/tt.svg?branch=master)](https://travis-ci.org/xandkar/tt)
6
3773a4cd
SK
7Doesn't force you to maintain a master "following" file (the way Twitter does),
8but let's you point it to any follow-file every time it runs.
9
10This means unlimited possibilities for ad-hoc, interesting filtering
11combinations. Especially when paired with
12[process substitution](https://en.wikipedia.org/wiki/Process_substitution).
13
01e4c499
SK
14### long format (default)
15![Screenshot](screenshot-long.jpg)
16
17### short format (CLI option: -s)
18![Screenshot](screenshot-short.jpg)
3773a4cd 19
236a8692 20
3773a4cd
SK
21instructions
22------------
23
24### requirements
25[Racket](https://download.racket-lang.org/)
26
27### installation
3b0e3842
SK
281. Run `make install` or `raco pkg install`
292. Add `$HOME/.racket/7.9/bin` to your `$PATH`
30 (replacing `7.9` with whatever version you have installed)
3773a4cd
SK
31
32### usage
58b95fe2
SK
33Download feeds from the Internet:
34`tt d (FOLLOW-FILE)`
35
24f1f64b
SK
36Read your timeline:
37`tt r (FOLLOW-FILE)`
38
39See the rest of the usage options:
40`tt -h`
58b95fe2
SK
41
42`tt <command> -h`
236a8692
SK
43
44
45notes
46-----
47
48### LWW downloads
49Downloaded timelines are stored in `~/.tt/cache/<SHA1_OF_URI>`, but no attempt
50is made to preserve the previously-downloaded messages - each download
51overrites the previous. One of the implications is that authors can edit/delete
52history without you noticing.
This page took 0.032625 seconds and 4 git commands to generate.