Add quick usage using correct source (#141)

* Add quick usage using correct source * Auto Format * Add more to README.yaml * Update README.yaml * Auto Format Co-authored-by: cloudpossebot <[email protected]>
cloudposse · Aug 12, 2021 · e20f805 · e20f805
1 parent 63facfd
commit e20f805
Show file tree

Hide file tree

Showing 2 changed files with 57 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -110,6 +110,31 @@ For complete examples, see
 
 For a complete example with automated tests, see [examples/complete](examples/complete) with `bats` and `Terratest` for the example [test](test).
 
+```hcl
+module "container_definition" {
+  source = "cloudposse/ecs-container-definition/aws"
+  # Cloud Posse recommends pinning every module to a specific version
+  # version = "x.x.x"
+
+  container_name  = "geodesic"
+  container_image = "cloudposse/geodesic"
+}
+```
+
+The output of this module can then be used with one of our other modules.
+
+```hcl
+module "ecs_alb_service_task" {
+  source = "cloudposse/ecs-alb-service-task/aws"
+  # Cloud Posse recommends pinning every module to a specific version
+  # version = "x.x.x"
+
+  # ...
+  container_definition_json = module.container_definition.json_map_encoded_list
+  # ...
+}
+```
+
 
 
 
@@ -359,8 +384,8 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
 ### Contributors
 
 <!-- markdownlint-disable -->
-|  [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Sarkis Varozian][sarkis_avatar]][sarkis_homepage]<br/>[Sarkis Varozian][sarkis_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] | [![Yonatan Koren][korenyoni_avatar]][korenyoni_homepage]<br/>[Yonatan Koren][korenyoni_homepage] |
-|---|---|---|---|---|
+|  [![Erik Osterman][osterman_avatar]][osterman_homepage]<br/>[Erik Osterman][osterman_homepage] | [![Sarkis Varozian][sarkis_avatar]][sarkis_homepage]<br/>[Sarkis Varozian][sarkis_homepage] | [![Andriy Knysh][aknysh_avatar]][aknysh_homepage]<br/>[Andriy Knysh][aknysh_homepage] | [![Igor Rodionov][goruha_avatar]][goruha_homepage]<br/>[Igor Rodionov][goruha_homepage] | [![Yonatan Koren][korenyoni_avatar]][korenyoni_homepage]<br/>[Yonatan Koren][korenyoni_homepage] | [![RB][nitrocode_avatar]][nitrocode_homepage]<br/>[RB][nitrocode_homepage] |
+|---|---|---|---|---|---|
 <!-- markdownlint-restore -->
 
   [osterman_homepage]: https://github.com/osterman
@@ -373,6 +398,8 @@ Check out [our other projects][github], [follow us on twitter][twitter], [apply
   [goruha_avatar]: https://img.cloudposse.com/150x150/https://github.com/goruha.png
   [korenyoni_homepage]: https://github.com/korenyoni
   [korenyoni_avatar]: https://img.cloudposse.com/150x150/https://github.com/korenyoni.png
+  [nitrocode_homepage]: https://github.com/nitrocode
+  [nitrocode_avatar]: https://img.cloudposse.com/150x150/https://github.com/nitrocode.png
 
 [![README Footer][readme_footer_img]][readme_footer_link]
 [![Beacon][beacon]][website]

diff --git a/README.yaml b/README.yaml
@@ -58,6 +58,32 @@ usage: |-
   - [string env vars](examples/string_env_vars)
 
   For a complete example with automated tests, see [examples/complete](examples/complete) with `bats` and `Terratest` for the example [test](test).
+  
+  ```hcl
+  module "container_definition" {
+    source = "cloudposse/ecs-container-definition/aws"
+    # Cloud Posse recommends pinning every module to a specific version
+    # version = "x.x.x"
+
+    container_name  = "geodesic"
+    container_image = "cloudposse/geodesic"
+  }
+  ```
+  
+  The output of this module can then be used with one of our other modules.
+  
+  ```hcl
+  module "ecs_alb_service_task" {
+    source = "cloudposse/ecs-alb-service-task/aws"
+    # Cloud Posse recommends pinning every module to a specific version
+    # version = "x.x.x"
+
+    # ...
+    container_definition_json = module.container_definition.json_map_encoded_list
+    # ...
+  }
+  ```
+
 include:
 - docs/targets.md
 - docs/terraform.md
@@ -72,3 +98,5 @@ contributors:
   github: goruha
 - name: Yonatan Koren
   github: korenyoni
+- name: RB
+  github: nitrocode