Update Readme

TobKed · Oct 27, 2020 · f8f987f · f8f987f
1 parent d664559
commit f8f987f
Showing 1 changed file with 10 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 <img alt="label-when-approved-action status"
     src="https://github.com/TobKed/label-when-approved-action/workflows/Test%20the%20build/badge.svg"></a>
 
-# Get Workflow Runs action
+# Label When Approved action
 
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
@@ -35,12 +35,12 @@ projects.
 
 ## Inputs
 
-| Input                         | Required | Example                                                         | Comment                                                                 |
-|-------------------------------|----------|-----------------------------------------------------------------|-------------------------------------------------------------------------|
-| `token`                       | yes      | `${{ secrets.GITHUB_TOKEN }}`                                   | The github token passed from `${{ secrets.GITHUB_TOKEN }}`              |
-| `label`                       | no       | `spproved by committers`                                        | Label to be added/removed to the Pull Request if approved/not approved  |
-| `require_committers_approval` | no       | `true`                                                          | Is approval from user with write permission required                    |
-| `comment`                     | no       | `This became approved, rerun tests manually or rebase and push` | Add optional comment to the PR when approved                            |
+| Input                         | Required | Example                                                           | Comment                                                                       |
+|-------------------------------|----------|-------------------------------------------------------------------|-------------------------------------------------------------------------------|
+| `token`                       | yes      | `${{ secrets.GITHUB_TOKEN }}`                                     | The github token passed from `${{ secrets.GITHUB_TOKEN }}`                    |
+| `label`                       | no       | `Approved by committers`                                          | Label to be added/removed to the Pull Request if approved/not approved        |
+| `require_committers_approval` | no       | `true`                                                            | Is approval from user with write permission required                          |
+| `comment`                     | no       | `PR approved by at least one committer and no changes requested.` | Add optional comment to the PR when approved (requires label input to be set) |
 
 ## Outputs
 
@@ -68,14 +68,15 @@ jobs:
       isApprovedByAnyone: ${{ steps.label-when-approved-by-anyone.outputs.isApproved }}
     steps:
       - name: Label when approved by commiters
-        uses: TobKed/label-when-approved-action@v0.1
+        uses: TobKed/label-when-approved-action@v1
         id: label-when-approved-by-commiters
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           label: 'ready to merge (committers)'
           require_committers_approval: 'true'
+          comment: 'PR approved by at least one committer and no changes requested.'
       - name: Label when approved by anyone
-        uses: TobKed/label-when-approved-action@v0.1
+        uses: TobKed/label-when-approved-action@v1
         id: label-when-approved-by-anyone
         with:
           token: ${{ secrets.GITHUB_TOKEN }}