From 10b1b479ae458b68365d5e50f2f2f16e259b1d59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89tienne=20Reuh=20Fildadut?= Date: Wed, 15 Oct 2025 16:09:35 +0200 Subject: [PATCH] docs: update container image references --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e1e95af..de3c1f1 100644 --- a/README.md +++ b/README.md @@ -96,12 +96,12 @@ Since, as the kids say, everything is a file, Feather can be easily integrated w ### Docker -If use Docker or Podman, an image is available at `codeberg.org/TODO`. +If use Docker or Podman, an image is available at `codeberg.org/reuh/feather:latest`. For example, to start a new container with the Feather daemon running, using the `config.yml` (see [basic configuration](#basic-configuration)) in the current directory and exposing the feeds in the `reader` directory: ```sh -docker run -d -v ./config.toml:/feather/config.toml:ro -v ./reader:/feather/reader -v feather-data:/feather/data --name feather TODO/feather daemon +docker run -d -v ./config.toml:/feather/config.toml:ro -v ./reader:/feather/reader -v feather-data:/feather/data --name feather codeberg.org/reuh/feather:latest daemon ``` Instead of using a configuration file, you may also use environment variables; see [the default configuration file](src/feather/config.default.toml) for details. @@ -120,11 +120,11 @@ Description=Feather container [Container] ContainerName=feather -Image=feather +Image=codeberg.org/reuh/feather:latest Exec=daemon -# Auto-update container TODO -#AutoUpdate=registry +# Auto-update container +AutoUpdate=registry # Configuration file Volume=%h/Feather/config.toml:/feather/config.toml:ro,Z @@ -213,5 +213,7 @@ While I mostly started this project for fun, it ended up actually quite usable, # TODO before publishing -- [ ] Write documentation +- [x] Write documentation + - [ ] Re-read +- [ ] Tag v1.0 in git & container - [ ] Publish