Documentation updates (#112)

* Updating README

* Updating README

Author: sudomateo

README.md

@@ -1,24 +1,26 @@
 # Terraform GitHub Actions
 
-Terraform GitHub Actions allow you to run Terraform commands within GitHub Actions.
+Terraform GitHub Actions allow you to execute Terraform commands within GitHub Actions.
 
 The output of the actions can be viewed from the Actions tab in the main repository view. If the actions are executed on a pull request event, a comment may be posted on the pull request.
 
+Terraform GitHub Actions are a single GitHub Action that executes different Terraform subcommands depending on the content of the GitHub Actions YAML file.
+
 ## Success Criteria
 
 An exit code of `0` is considered a successful execution.
 
 ## Usage
 
-The most common use case is to run `terraform fmt`, `terraform init`, `terraform validate`, and `terraform plan` on a pull request. A comment will be posted to the pull request depending on the output of the Terraform command being executed.
+The most common workflow is to run `terraform fmt`, `terraform init`, `terraform validate`, and `terraform plan` on all of the Terraform files in the root of the repository when a pull request is opened or updated. A comment will be posted to the pull request depending on the output of the Terraform subcommand being executed. This workflow can be configured by adding the following content to the GitHub Actions workflow YAML file.
 
 ```yaml
-name: 'Terraform Pull Request Workflow'
+name: 'Terraform GitHub Actions'
 on:
   - pull_request
 jobs:
-  example:
-    name: 'Terraform Actions'
+  terraform:
+    name: 'Terraform'
     runs-on: ubuntu-latest
     steps:
       - name: 'Checkout'
@@ -61,36 +63,38 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-This was a simplified example showing the basic features of these Terraform GitHub Actions. Please refer to the examples within the `examples` directory for more examples of common workflows.
+This was a simplified example showing the basic features of these Terraform GitHub Actions. Please refer to the examples within the `examples` directory for other common workflows.
 
 ## Inputs
 
-| Name                     | Required | Default | Description                                                                                       |
-|--------------------------|----------|---------|---------------------------------------------------------------------------------------------------|
-| `tf_actions_version`     | `true`   |         | Terraform version to install and execute.                                                         |
-| `tf_actions_subcommand`  | `true`   |         | Terraform subcommand to execute. Valid values are `fmt`, `init`, `validate`, `plan`, and `apply`. |
-| `tf_actions_working_dir` | `false`  | `.`     | The working directory to change into before executing Terraform commands.                         |
-| `tf_actions_comment`     | `false`  | `true`  | Whether or not to comment on pull requests.                                                       |
+Inputs configure Terraform GitHub Actions to perform different actions.
+
+* `tf_actions_version` - (Required) The Terraform version to install and execute.
+* `tf_actions_subcommand` - (Required) The Terraform subcommand to execute. Valid values are `fmt`, `init`, `validate`, `plan`, and `apply`.
+* `tf_actions_working_dir` - (Optional) The working directory to change into before executing Terraform subcommands. Defaults to `.` which means use the root of the GitHub repository.
+* `tf_actions_comment` - (Optional) Whether or not to comment on GitHub pull requests. Defaults to `true`.
 
 ## Outputs
 
-| Name                          | Description                                          |
-|-------------------------------|------------------------------------------------------|
-| `tf_actions_plan_has_changes` | Whether or not the Terraform plan contained changes. |
+Outputs are used to pass information to subsequent GitHub Actions steps.
+
+* `tf_actions_plan_has_changes` - Whether or not the Terraform plan contained changes.
 
 ## Secrets
 
-| Name                     | Description                                                                                                          |
-|--------------------------|----------------------------------------------------------------------------------------------------------------------|
-| `GITHUB_TOKEN`           | The GitHub API token used to post comments to pull requests. Not required if `tf_actions_comment` is set to `false`. |
+Secrets are similar to inputs except that they are encrypted and only used by GitHub Actions. It's a convenient way to keep sensitive data out of the GitHub Actions workflow YAML file.
 
-Other secrets may be needed to authenticate with Terraform backends and providers. 
+* `GITHUB_TOKEN` - (Optional) The GitHub API token used to post comments to pull requests. Not required if the `tf_actions_comment` input is set to `false`.
 
-**WARNING:** These secrets could be exposed if the action is executed on a malicious Terraform file. To avoid this, it is recommended to not use this action on public repos or repos where untrusted users can submit pull requests.
+Other secrets may be needed to authenticate with Terraform backends and providers.
+
+**WARNING:** These secrets could be exposed if the action is executed on a malicious Terraform file. To avoid this, it is recommended not to use these Terraform GitHub Actions on repositories where untrusted users can submit pull requests.
 
 ## Environment Variables
 
-The usual [Terraform environment variables](https://www.terraform.io/docs/commands/environment-variables.html) are supported. Here are the environment variables that might be the most beneficial.
+Environment variables are exported in the environment where the Terraform GitHub Actions are executed. This allows a user to modify the behavior of certain GitHub Actions.
+
+The usual [Terraform environment variables](https://www.terraform.io/docs/commands/environment-variables.html) are supported. Here are a few of the more commonly used environment variables.
 
 * [`TF_LOG`](https://www.terraform.io/docs/commands/environment-variables.html#tf_log)
 * [`TF_VAR_name`](https://www.terraform.io/docs/commands/environment-variables.html#tf_var_name)

src/terraform_validate.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 function terraformValidate {
-  # Gather the ouput of `terraform validate`.
+  # Gather the output of `terraform validate`.
   echo "validate: info: validating Terraform configuration in ${tfWorkingDir}"
   validateOutput=$(terraform validate ${*} 2>&1)
   validateExitCode=${?}