Merge pull request #29 from adinhodovic/add-description

docs: Add description to readme
adinhodovic · Dec 14, 2023 · 8648645 · 8648645
2 parents 5a2392a + 4b3b3c4
commit 8648645
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
 # Terraform-Cloudflare-Maintenance
 
-Terraform module to create a responsive **Maintenance Page** using
-Cloudflare Workers.
+Terraform module to create a responsive **Maintenance Page** using Cloudflare Workers.
+
+The Cloudflare script intercepts all incoming requests and checks if the request is coming from an IP that is in the whitelist or if the request path matches a whitelisted path. If the request is not whitelisted, it returns a maintenance page.
 
 The module can be used through [Terraform's registry](https://registry.terraform.io/modules/adinhodovic/maintenance/cloudflare/latest).