From e8b5b0796d7c860dc0510efe2e5833b663e7b732 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bal=C3=A1zs=20Buri?= <burib@users.noreply.github.com>
Date: Fri, 15 Nov 2024 11:48:31 +0100
Subject: [PATCH] docs: update readme

---
 README.md | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index c7115aa..0186c95 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,15 @@
-# terraform-aws-module-template
+# terraform-route53-with-wildcard-acm-module
 
-## github template to start writing versioned terraform module
+### creates a Route53 Public Hosted Zone with Wildcard ACM Certificate validated through dns records. 
+###### For DNS validation make sure the propagation works by creating the required NS records after the HZ is created. 
+###### Otherwise the certificate will never get verified and terraform keeps hanging.  
+
+
+# Usage example:
+```terraform
+module "my_awesome_domain" {
+  source = "github.com/burib/terraform-route53-with-acm?ref=v0"
+
+  domain = local.is_prod ? "example.com" : "${var.environment}.example.com"
+}
+```