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

Browse source
This commit is contained in:
Étienne Fildadut 2025-10-09 17:50:09 +02:00
parent f52747b516
commit e5b9fec570
2 changed files with 18 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Dockerfile
View file

@ -5,6 +5,6 @@ RUN apk add --no-cache python3 py3-requests py3-jinja2
RUN mkdir /feather RUN mkdir /feather
WORKDIR /feather WORKDIR /feather
COPY *.py config.default.toml LICENSE /feather COPY *.py config.default.toml LICENSE /feather/
ENTRYPOINT [ "python3", "main.py" ] ENTRYPOINT [ "python3", "main.py" ]

18
README.md
View file

@ -2,8 +2,24 @@
## Usage ## 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 ## Installation
### Docker
### Raw
## FAQ ## FAQ
### Why ### Why
@ -22,6 +38,6 @@
- [ ] Share the fun somewhere - [ ] Share the fun somewhere
- [x] Edge cases: mark as read during sync (if marked as read on server or not) - [x] Edge cases: mark as read during sync (if marked as read on server or not)
- [x] Proper filename escaping - [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 - [x] Handle item updates
- [ ] Actually think about the issues created by the duplicate warning - [ ] Actually think about the issues created by the duplicate warning