From f788279756219806bf015d42ff138a41ab5ee3f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89tienne=20Reuh=20Fildadut?= Date: Thu, 9 Oct 2025 15:30:26 +0200 Subject: [PATCH] docs: update readme --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7df2c56..37edc9b 100644 --- a/README.md +++ b/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 +