Update README.md

Lupus-Metallum · Apr 25, 2021 · 76c1ab5 · 76c1ab5
1 parent 6052d5c
commit 76c1ab5
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,16 @@
 # terraform-aws-s3-static-website
 Used to publish static website files to an S3 bucket with proper MIME type
+
+## Example
+
+``` Terraform
+module "s3-static-website" {
+  source        = "Lupus-Metallum/s3-static-website/aws"
+  version       = "1.0.1"
+  
+  bucket_id     = aws_s3_bucket.example.id
+  file_path     = "${path.module}/src/my-website-files/" # Where your index.html and TLD web content lives
+  acl           = "public-read"
+  storage_class = "STANDARD"
+}
+```