Reuh/feather
1
0
Fork 0
mirror of https://codeberg.org/Reuh/feather.git synced 2025-10-27 18:19:32 +00:00
Code Releases Activity

docs: update README

Browse source
This commit is contained in:
Étienne Fildadut 2025-10-10 13:28:45 +02:00
parent 360117deb1
commit b83d86326a
1 changed files with 16 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

20
README.md
View file

@ -1,10 +1,16 @@
# Feather: file-based RSS reader # Feather: file-based RSS reader client
## Usage ## Usage
### Reading a feed start with pictures/gif each time
Directories, opening an item, sorting/searching by date/title (a.k.a. using a file manager) ### Navigating feeds
Directories, sorting/searching by date/title (a.k.a. using a file manager)
### Reading an item
opening an item
### Marking items as read ### Marking items as read
@ -22,6 +28,8 @@ Call `feather sync` to synchronize all local data with the server (read items, n
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.). 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.).
`feather clear-data`
### Theoretical use-cases ### Theoretical use-cases
#### Processing with scripts #### Processing with scripts
@ -36,6 +44,8 @@ After changing the configuration, you can call `feather regenerate` to regenerat
### Raw ### Raw
You need Python 3.12 or newer. Then pip it up.
## FAQ ## FAQ
### Why ### Why
@ -48,7 +58,7 @@ After changing the configuration, you can call `feather regenerate` to regenerat
- [ ] Write documentation - [ ] Write documentation
- [x] Perform mark-as-read operation more often than sync (inotify, daemon, etc.) - [x] Perform mark-as-read operation more often than sync (inotify, daemon, etc.)
- [ ] inotify might still be nice - [ ] inotify might still be nice for instant reactions
- [x] Make HTML filename configurable - [x] Make HTML filename configurable
- [x] Make HTML template configurable - [x] Make HTML template configurable
- [ ] Nested categories: ttrss-python? - [ ] Nested categories: ttrss-python?
@ -59,3 +69,5 @@ After changing the configuration, you can call `feather regenerate` to regenerat
- [x] Handle item updates - [x] Handle item updates
- [ ] Actually think about the issues created by the duplicate warning - [ ] Actually think about the issues created by the duplicate warning
- [x] Set generated files creation/modification date instead of putting date in filename - [x] Set generated files creation/modification date instead of putting date in filename
- [ ] Make a proper Python package