Skip to content

Commit b29355b

Browse files
committed
doc: update README
1 parent 455abe8 commit b29355b

File tree

1 file changed

+37
-7
lines changed

1 file changed

+37
-7
lines changed

README.md

+37-7
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,45 @@
66

77
Syndicationd is a TUI feed viewer, based on [feed-rs](https://github.com/feed-rs/feed-rs) and [ratatui](https://github.com/ratatui-org/ratatui).
88

9-
## Development
109

11-
```sh
12-
# Setup local environment
13-
nix develop
10+
## Features
1411

15-
# Run check
16-
just check
17-
```
12+
* Subscribe feeds(RSS1, RSS2, Atom,...) and browse latest entries
13+
* Open the entry in a browser
14+
15+
16+
## Install
17+
18+
### Nix
19+
20+
`nix run github:ymgyt/syndicationd`
21+
22+
### Cargo
23+
24+
`cargo install synd-term --locked`
25+
26+
27+
## Usage
28+
29+
### Log file
30+
31+
The log file path is based on [`ProjectDirs::data_dir()`](https://docs.rs/directories/latest/directories/struct.ProjectDirs.html#method.data_dir).
32+
Please refer to the `--log` flag in `synd --help` for the default output destination.
33+
34+
You can modify the [log directives](https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives) using the environment variable `SYND_LOG`. (for example, `SYND_LOG=synd=debug`)
35+
36+
### Theme
37+
38+
The theme can be changed using the `--theme` flag. Please refer to the help for the values that can be specified.
39+
40+
### Backend api
41+
42+
By default, use `https://syndicationd.ymgyt.io` as the backend api([hosted on my home Raspberry Pi](https://github.com/ymgyt/mynix/blob/main/homeserver/modules/syndicationd/default.nix)).
43+
To change the endpoint, specify the `--endpoint` flag
44+
45+
### Clear cache and logs
46+
47+
Authentication credentials are cached. to remove them, execute `synd clear`.
1848

1949
## License
2050

0 commit comments

Comments
 (0)