From a2ba8e05e65648dde0551ee831ee2f5744a847a0 Mon Sep 17 00:00:00 2001
From: Martin Kagamino Lehoux <martin@lehoux.net>
Date: Fri, 13 Feb 2026 08:46:23 +0100
Subject: Replace Caddyfile.example with README.md

Move the Caddy config example into the README alongside
build, usage, and test instructions.
---
 README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 46 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..207a7cd
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# kagapics
+
+A lightweight, self-hosted photo gallery for collecting trip photos from friends. Single Go binary, no database, no runtime dependencies.
+
+## Build
+
+```sh
+go build -o gallery .
+```
+
+## Usage
+
+### Create a gallery
+
+```sh
+./gallery create <name> <password> [--data ./gallery-data] [--no-thumbs]
+```
+
+### Start the server
+
+```sh
+./gallery serve [--addr :8080] [--data ./gallery-data]
+```
+
+### Caddy reverse proxy
+
+```caddy
+{
+    supervisor {
+        ./gallery serve --addr :8020 --data ./gallery-data {
+            dir /home/ubuntu
+            restart_policy always
+        }
+    }
+}
+
+pics.example.com {
+    reverse_proxy localhost:8020
+}
+```
+
+## Test
+
+```sh
+go test ./...
+```
-- 
cgit v1.3