Add README
Assisted-by: Claude Opus 5 via Claude Code
change rxmlqllrsnprluzqkworympnsspsvyqr
commit 46c41f5f6cedff95e36ba9776de090f47b6f9d6e
author Alpha Chen <alpha@kejadlen.dev>
date
parent mzoxukky
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..51e2578
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# caddy-tailscale
+
+A [Caddy](https://caddyserver.com) image with the
+[caddy-tailscale](https://github.com/tailscale/caddy-tailscale) and
+[caddy-ratelimit](https://github.com/mholt/caddy-ratelimit) plugins, published
+to `ghcr.io/kejadlen/caddy-tailscale`.
+
+## Tags
+
+- `<caddy>-<yyyy.mm.dd>`, like `2.11.4-2026.09.14`, is a specific build.
+- `<caddy>`, like `2.11.4`, is the newest build for that Caddy version.
+- `latest` is the newest build of the latest Caddy release.
+
+## Release
+
+Run the release workflow from the Actions tab, or from the terminal:
+
+```sh
+just release [caddy] [tailscale] [ratelimit]
+```
+
+Blank versions default to the latest. A plugin version can be a tag, a commit
+hash, or a branch. The run summary and image labels record the plugin versions
+that went into the build.