update docs

cloudposse · Nov 22, 2024 · 011cb73 · 011cb73
1 parent 8a3219e
commit 011cb73
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -119,6 +119,10 @@ func TestAwsNuke(t *testing.T) {
 
 ### pkg/atmos/aws-component-helper
 
+This package is designed to be used to test components that follow the Cloud Posse convention for AWS Components
+(terraform root modules). The code below demonstrates how to standup a test suite, deploy dependencies, deploy the
+component under test, run assertions, and then destroy the component under test and its dependencies.
+
 ```go
 package test
 

diff --git a/README.yaml b/README.yaml
@@ -108,6 +108,10 @@ introduction: |-
 
   ### pkg/atmos/aws-component-helper
 
+  This package is designed to be used to test components that follow the Cloud Posse convention for AWS Components
+  (terraform root modules). The code below demonstrates how to standup a test suite, deploy dependencies, deploy the
+  component under test, run assertions, and then destroy the component under test and its dependencies.
+
   ```go
   package test