chore: update readme
8e129785
1 file(s) · +24 −8
| 1 | - | # bullet |
|
| 1 | + | # bullets |
|
| 2 | 2 | ||
| 3 | - | This is a [Ratatui] app generated by the [Hello World template]. |
|
| 3 | + | Minimal terminal RSS reader. Pass one or more feed URLs, browse entries, open in browser. |
|
| 4 | 4 | ||
| 5 | - | [Ratatui]: https://ratatui.rs |
|
| 6 | - | [Hello World Template]: https://github.com/ratatui/templates/tree/main/hello-world |
|
| 5 | + | ## Usage |
|
| 7 | 6 | ||
| 8 | - | ## License |
|
| 7 | + | ```sh |
|
| 8 | + | bullets <feed-url> [feed-url ...] |
|
| 9 | + | ``` |
|
| 9 | 10 | ||
| 10 | - | Copyright (c) Steve <contact@stevedylan.dev> |
|
| 11 | + | Feed discovery included — bare domains (e.g. `stevedylan.dev`) are probed for RSS/Atom feeds automatically. |
|
| 11 | 12 | ||
| 12 | - | This project is licensed under the MIT license ([LICENSE] or <http://opensource.org/licenses/MIT>) |
|
| 13 | + | ## Keybindings |
|
| 13 | 14 | ||
| 14 | - | [LICENSE]: ./LICENSE |
|
| 15 | + | | Key | Action | |
|
| 16 | + | |-----|--------| |
|
| 17 | + | | `j` / `↓` | Next entry | |
|
| 18 | + | | `k` / `↑` | Prev entry | |
|
| 19 | + | | `Enter` | Open in browser | |
|
| 20 | + | | `q` | Quit | |
|
| 21 | + | ||
| 22 | + | ## Install |
|
| 23 | + | ||
| 24 | + | ```sh |
|
| 25 | + | cargo install --path . |
|
| 26 | + | ``` |
|
| 27 | + | ||
| 28 | + | ## License |
|
| 29 | + | ||
| 30 | + | MIT — Copyright (c) Steve <contact@stevedylan.dev> |