From 42d7ef1c812237812da42c3beef786172601395f Mon Sep 17 00:00:00 2001 From: Brian Picciano Date: Thu, 4 Jul 2024 18:43:13 +0200 Subject: Update README with build instructions --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) 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 -- cgit v1.2.3