From ffc10c2b8608c13369a777414f7382efaba2d455 Mon Sep 17 00:00:00 2001
From: poslop <poslop@archfox.org>
Date: Wed, 9 Sep 2026 16:16:28 +0000
Subject: [PATCH] README: link to docker-compose example

---
 README.md | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/README.md b/README.md
index 4223257..48f3ce9 100644
--- a/README.md
+++ b/README.md
@@ -95,6 +95,12 @@ Gitea Actions workflow at `.gitea/workflows/ci.yml`:
 - On push to main: `go vet` + `go test`
 - On tags: build and push Docker image to `git.archfox.org/poslop/palette`
 
+## Docker Compose
+
+See [docker-compose.yml](docker-compose.yml) for a ready-to-use example with
+every environment variable documented, including which are required (only the
+/data volume) and which are optional.
+
 ## License
 
 Palette is licensed under the GNU Affero General Public License v3.0