BBL-440 | fixing README.md with pre-commit terraform-docs hook

binbashar · Nov 16, 2020 · c8c1f4f · c8c1f4f
1 parent 52d064a
commit c8c1f4f
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 9 deletions.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -9,7 +9,7 @@ assignees: ''
 
 ## Describe the Feature
 
-A clear and concise description of what the bug is. 
+A clear and concise description of what the bug is.
 
 ## Expected Behavior
 

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -3,11 +3,11 @@
 * Use bullet points to be concise and to the point.
 
 ## why
-* Provide the justifications for the changes (e.g. business case). 
+* Provide the justifications for the changes (e.g. business case).
 * Describe why these changes were made (e.g. why do these commits fix the problem?)
 * Use bullet points to be concise and to the point.
 
 ## references
-* Link to any supporting github issues or helpful documentation to add some context (e.g. stackoverflow). 
+* Link to any supporting github issues or helpful documentation to add some context (e.g. stackoverflow).
 * Use `closes #123`, if this PR closes a GitHub issue `#123`
 
diff --git a/README.md b/README.md
@@ -35,15 +35,31 @@ module "vpc-natgw-notifications" {
 ```
 
 <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| terraform | >= 0.12 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| aws | n/a |
+
 ## Inputs
 
 | Name | Description | Type | Default | Required |
-|------|-------------|:----:|:-----:|:-----:|
-| alarm\_evaluation\_periods | The number of periods over which data is compared to the specified threshold. | number | `"1"` | no |
-| alarm\_period | The period in seconds over which the specified statistic is applied, eg 3600 sec = 60 mins. | number | `"3600"` | no |
-| alarm\_suffix | Suffix to add to alarm name, used for separating different AWS account. | string | `""` | no |
-| send\_sns | If true will send message *Successful AWS console login with the root account* to SNS topic. | bool | `"false"` | no |
-| sns\_topic\_name | The name of the SNS topic to send root login notifications. | string | n/a | yes |
+|------|-------------|------|---------|:--------:|
+| alarm\_evaluation\_periods | The number of periods over which data is compared to the specified threshold. | `number` | `1` | no |
+| alarm\_period | The period in seconds over which the specified statistic is applied, eg 3600 sec = 60 mins. | `number` | `3600` | no |
+| alarm\_suffix | Suffix to add to alarm name, used for separating different AWS account. | `string` | `""` | no |
+| send\_sns | If true will send message *Successful AWS console login with the root account* to SNS topic. | `bool` | `false` | no |
+| sns\_topic\_name | The name of the SNS topic to send root login notifications. | `string` | n/a | yes |
+
+## Outputs
+
+No output.
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->