mirror of
https://codeberg.org/Reuh/feather.git
synced 2025-10-28 02:29:32 +00:00
54 lines
1.3 KiB
Markdown
54 lines
1.3 KiB
Markdown
# Feather: local file-based RSS reader
|
|
|
|
## Usage
|
|
|
|
### Reading a feed
|
|
|
|
### Marking items as read
|
|
|
|
### Updating with the server
|
|
|
|
Call `feather sync` to synchronize all local data with the server (read items, new items from the server, etc.).
|
|
|
|
`feather daemon`
|
|
|
|
### Configuration
|
|
|
|
After changing the configuration, you can call `feather regenerate` to regenerate all local files with the new configuration (to reflect the changes in the HTML template, filenames, etc.).
|
|
|
|
### Theoretical use-cases
|
|
|
|
#### Processing with scripts
|
|
|
|
#### Syncthing
|
|
|
|
## Installation
|
|
|
|
### Docker
|
|
|
|
`podman run -d -v ./config.toml:/feather/config.toml -v ./data:/feather/data -v ./reader:/feather/reader --name feather feather daemon`
|
|
|
|
### Raw
|
|
|
|
## FAQ
|
|
|
|
### Why
|
|
|
|
### Name
|
|
|
|
### What should I eat tonight
|
|
|
|
## TODO
|
|
|
|
- [ ] Write documentation
|
|
- [x] Perform mark-as-read operation more often than sync (inotify, daemon, etc.)
|
|
- [ ] inotify might still be nice
|
|
- [x] Make HTML filename configurable
|
|
- [x] Make HTML template configurable
|
|
- [ ] Nested categories
|
|
- [ ] Share the fun somewhere
|
|
- [x] Edge cases: mark as read during sync (if marked as read on server or not)
|
|
- [x] Proper filename escaping
|
|
- [x] Command to force regenerate all HTML files (incl. recompute datetimes & paths)
|
|
- [x] Handle item updates
|
|
- [ ] Actually think about the issues created by the duplicate warning
|