Small update after adding with-aggregate-type-defaults option to terraform-docs (#209)

This commit is contained in:
Max Williams
2018-12-12 17:07:10 +01:00
committed by GitHub
parent edbea30cfc
commit 6d38ca4ead
4 changed files with 22 additions and 22 deletions

10
main.tf
View File

@@ -67,11 +67,11 @@
* ## Doc generation
* Documentation should be modified within `main.tf` and generated using [terraform-docs](https://github.com/segmentio/terraform-docs).
* Generate them like so:
* ```bash
* go get github.com/segmentio/terraform-docs
* terraform-docs md ./ | cat -s | tail -r | tail -n +2 | tail -r > README.md
*
* Install it with `go get github.com/segmentio/terraform-docs` or `brew install terraform-docs` and then use it to generate the `README.md` file:
*
* ```
* terraform-docs --with-aggregate-type-defaults md ./ | cat -s | tail -r | tail -n +2 | tail -r > README.md
* ```
* ## Contributing