diff --git a/.terraform-docs.yml b/.terraform-docs.yml new file mode 100644 index 0000000..7069923 --- /dev/null +++ b/.terraform-docs.yml @@ -0,0 +1,13 @@ +--- +formatter: markdown table +output: + file: README.md + mode: inject + template: |- + + {{ .Content }} + +settings: + anchor: false + html: false + lockfile: false diff --git a/README.md b/README.md index f3a98b6..0bd7f2a 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ module "example" { - [Basic usage](https://github.com/cisagov/skeleton-tf-module/tree/develop/examples/basic_usage) + ## Requirements ## | Name | Version | @@ -73,6 +74,7 @@ No modules. | id | The EC2 instance ID. | | private\_ip | The private IP of the EC2 instance. | | subnet\_id | The ID of the subnet where the EC2 instance is deployed. | + ## Notes ##