From e5b9fec57046fb1b49dee5226dc8ad1d9526766c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89tienne=20Reuh=20Fildadut?= Date: Thu, 9 Oct 2025 17:50:09 +0200 Subject: [PATCH] docs: update --- Dockerfile | 2 +- README.md | 18 +++++++++++++++++- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/Dockerfile b/Dockerfile index e3055bd..dc436bc 100644 --- a/Dockerfile +++ b/Dockerfile @@ -5,6 +5,6 @@ RUN apk add --no-cache python3 py3-requests py3-jinja2 RUN mkdir /feather WORKDIR /feather -COPY *.py config.default.toml LICENSE /feather +COPY *.py config.default.toml LICENSE /feather/ ENTRYPOINT [ "python3", "main.py" ] diff --git a/README.md b/README.md index c44714c..9250677 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,24 @@ ## Usage +### Reading a feed + +### Marking items as read + +### Updating with the server + +Call `feather update` to synchronize all local data with the server (read items, new items from the server, etc.). + +### 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.). + ## Installation +### Docker + +### Raw + ## FAQ ### Why @@ -22,6 +38,6 @@ - [ ] Share the fun somewhere - [x] Edge cases: mark as read during sync (if marked as read on server or not) - [x] Proper filename escaping -- [ ] Command to force regenerate all HTML files (incl. recompute datetimes & paths) +- [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