Fix README example (#9)

* Fix README example * Auto Format Co-authored-by: cloudpossebot <11232728+cloudpossebot@users.noreply.github.com>
cloudposse · Jun 4, 2021 · 399951e · 399951e
1 parent 7764737
commit 399951e
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -115,13 +115,16 @@ The table below correctly indicates which inputs are required.
 Here's how to invoke this example module in your projects
 
 ```hcl
-module "example" {
-  source = "https://github.com/cloudposse/terraform-aws-utils.git?ref=master"
+locals {
+  shorten_regions   = true
+  naming_convention = local.shorten_regions ? "to_short" : "identity"
+  az_map            = module.example.region_az_alt_code_maps[local.naming_convention]
 }
 
-locals {
-  naming_convention = var.shorten_regions ? "to_short" : "identity"
-  az_map = module.example.region_az_alt_code_maps[local.naming_convention]]
+module "utils_example_complete" {
+  source  = "cloudposse/utils/aws"
+  # Cloud Posse recommends pinning every module to a specific version
+  # version     = "x.x.x"
 }
 
 module "label" {

diff --git a/README.yaml b/README.yaml
@@ -82,13 +82,16 @@ usage: |-
   Here's how to invoke this example module in your projects
 
   ```hcl
-  module "example" {
-    source = "https://github.com/cloudposse/terraform-aws-utils.git?ref=master"
+  locals {
+    shorten_regions   = true
+    naming_convention = local.shorten_regions ? "to_short" : "identity"
+    az_map            = module.example.region_az_alt_code_maps[local.naming_convention]
   }
 
-  locals {
-    naming_convention = var.shorten_regions ? "to_short" : "identity"
-    az_map = module.example.region_az_alt_code_maps[local.naming_convention]]
+  module "utils_example_complete" {
+    source  = "cloudposse/utils/aws"
+    # Cloud Posse recommends pinning every module to a specific version
+    # version     = "x.x.x"
   }
 
   module "label" {