From d00cbd50803f47cbaedce901a9030bf712ee8ba6 Mon Sep 17 00:00:00 2001 From: Matthew Holt Date: Wed, 31 Mar 2021 18:53:37 -0600 Subject: [PATCH] readme: Add build instructions --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 366e9e8..d97769a 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,15 @@ Please note that this module is still unfinished and may have bugs. Please try i - Admin API endpoints to inspect or modify rate limits +## Building + +To build Caddy with this module, use [xcaddy](https://github.com/caddyserver/xcaddy): + +```bash +$ xcaddy build --with github.com/mholt/caddy-ratelimit +``` + + ## Explanation The `rate_limit` HTTP handler module lets you define rate limit zones, which have a unique name of your choosing.