Skip to content

Commit

Permalink
Update readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
SkypLabs committed Jan 3, 2021
1 parent f7017c6 commit 8e37a90
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ Template of a minimal Terraform module.

This module follows the [standard structure][standard-module-structure] described in the [Terraform documentation][terraform-docs].

The following non-standard but commonly used files and folders have also been added:

* `local.tf`
* `data.tf`
* `templates`

A [pre-commit][pre-commit] configuration file is present to automatically format and validate the code and update the readme file upon Git commits.

<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Requirements

Expand All @@ -25,5 +33,6 @@ No output.

<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

[pre-commit]: https://pre-commit.com/ "pre-commit Website"
[standard-module-structure]: https://www.terraform.io/docs/modules/index.html#standard-module-structure "Terraform Documentation - Standard Module Structure"
[terraform-docs]: https://www.terraform.io/docs/ "Terraform Documentation"

0 comments on commit 8e37a90

Please sign in to comment.