chore: update README

Signed-off-by: Khosrow Moossavi <[email protected]>
terraform-docs · Sep 18, 2024 · ceebb78 · ceebb78
1 parent 4b070bd
commit ceebb78
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/.github/templates/README.tpl b/.github/templates/README.tpl
@@ -6,7 +6,8 @@
 {{- $tfdocsversion := or (getenv "TERRAFORM_DOCS_VERSION") "v0.0.0" -}}
 # terraform-docs GitHub Actions
 
-{{ $action.description }}
+{{ $action.description }}.
+
 In addition to statically defined directory modules, this module can search specific
 subfolders or parse `atlantis.yaml` for module identification and doc generation. This
 action has the ability to auto commit docs to an open PR or after a push to a specific

diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # terraform-docs GitHub Actions
 
-A Github action for generating Terraform module documentation using terraform-docs and gomplate.
+Generate Terraform module documentation in pull requests.
+
 In addition to statically defined directory modules, this module can search specific
 subfolders or parse `atlantis.yaml` for module identification and doc generation. This
 action has the ability to auto commit docs to an open PR or after a push to a specific