From 7a6e1d04f9a7a38078869a193ac8550eb486b027 Mon Sep 17 00:00:00 2001 From: Matt Calhoun Date: Thu, 19 Nov 2020 11:06:25 -0500 Subject: [PATCH] update usage language --- README.md | 5 ++++- README.yaml | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 40b4383..72cff31 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,10 @@ We literally have [*hundreds of terraform modules*][terraform_modules] that are Instead pin to the release tag (e.g. `?ref=tags/x.y.z`) of one of our [latest releases](https://github.com/cloudposse/terraform-example-module/releases). -Here's how to invoke this example module in your projects +For a complete example, see [examples/complete](examples/complete). + +For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest) +(which tests and deploys the example on AWS), see [test](test). ```hcl module "example" { diff --git a/README.yaml b/README.yaml index dfc9acb..6a348ae 100644 --- a/README.yaml +++ b/README.yaml @@ -66,7 +66,10 @@ description: |- # How to use this module. Should be an easy example to copy and paste. usage: |- - Here's how to invoke this example module in your projects + For a complete example, see [examples/complete](examples/complete). + + For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest) + (which tests and deploys the example on AWS), see [test](test). ```hcl module "example" {