docs: Fix formatting in README (#4)

borchero · Apr 29, 2024 · d191643 · d191643
1 parent ca0d899
commit d191643
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # terraform-plan-comment
 
-GitHub Action to post the output of `terraform plan` to a PR comment.
+GitHub Action to post the output of `terraform plan` to a pull request comment.
 
 ## Features
 
@@ -65,7 +65,9 @@ unless `terraform` cannot be found in the `PATH`.
 The directory where the Terraform binary ought to be called. Defaults to `$GITHUB_WORKSPACE` and _must_ be specified if
 `terraform init` has been run in a different directory. Should be specified relative to `$GITHUB_WORKSPACE`.
 
-> [!IMPORTANT] > `planfile` must be specified relative to the working directory.
+<!-- prettier-ignore -->
+> [!IMPORTANT]
+> `planfile` must be specified relative to the working directory.
 
 ### `id`
 

diff --git a/action.yml b/action.yml
@@ -1,8 +1,8 @@
 name: Terraform Plan Comment
-description: Post the output of `terraform plan` to a PR comment.
+description: Post the output of `terraform plan` to a pull request comment.
 author: Oliver Borchert
 branding:
-  icon: type
+  icon: git-pull-request
   color: purple
 inputs:
   token: