aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBrian Picciano <me@mediocregopher.com>2024-07-04 18:43:13 +0200
committerBrian Picciano <me@mediocregopher.com>2024-07-04 19:00:14 +0200
commit42d7ef1c812237812da42c3beef786172601395f (patch)
treecfd405f482330317f872ca5008661608d44d87e0
parentc9d28a108d6df59a895dd10f47e834ceba20f98a (diff)
Update README with build instructions
-rw-r--r--README.md20
1 files changed, 19 insertions, 1 deletions
diff --git a/README.md b/README.md
index 30a3285..85c28e5 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,25 @@ TODO proper introduction
## Build
-TODO
+A Caddy binary with these plugins included can be built using the
+[xcaddy][xcaddy] tool:
+
+```bash
+xcaddy build --with dev.mediocregopher.com/mediocre-caddy-plugins.git
+```
+
+If you want just a specific plugin you can choose it using its module path:
+
+```bash
+xcaddy build \
+ --with dev.mediocregopher.com/mediocre-caddy-plugins.git/http/handlers/templates/functions
+```
+
+It's also possible to build Caddy manually using a custom `main.go` file, see
+[the example from the caddy repo][caddymain].
+
+[xcaddy]: https://github.com/caddyserver/xcaddy
+[caddymain]: https://github.com/caddyserver/caddy/blob/master/cmd/caddy/main.go
## Plugins