mirror of
https://codeberg.org/Reuh/feather.git
synced 2025-10-27 18:19:32 +00:00
docs: update readme
This commit is contained in:
parent
d29b97ebf5
commit
f788279756
1 changed files with 19 additions and 2 deletions
21
README.md
21
README.md
|
|
@ -1,10 +1,27 @@
|
|||
# Feather: local file-based RSS reader
|
||||
|
||||
## Usage
|
||||
|
||||
## Installation
|
||||
|
||||
## FAQ
|
||||
|
||||
### Why
|
||||
|
||||
### Name
|
||||
|
||||
### What should I eat tonight
|
||||
|
||||
## TODO
|
||||
|
||||
- [ ] Write documentation
|
||||
- [ ] Perform mark-as-read operation more often than sync (inotify, daemon, etc.)
|
||||
- [ ] Make HTML filename configurable
|
||||
- [ ] Make HTML template configurable
|
||||
- [x] Make HTML filename configurable
|
||||
- [x] Make HTML template configurable
|
||||
- [ ] Nested categories
|
||||
- [ ] Share the fun somewhere
|
||||
- [ ] Edge cases: mark as read during sync (if marked as read on server or not)
|
||||
- [ ] Proper filename escaping
|
||||
- [ ] Command to force regenerate all HTML files (incl. recompute datetimes & paths)
|
||||
- [ ] Handle item updates
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue