Merge pull request #3 from seriousben/prep-release

README.md

@@ -2,3 +2,44 @@
 
 This action runs [go-patch-cover](https://github.com/seriousben/go-patch-cover) to display test coverage for code changed within a pull request.
 
+![Comment example](docs/comment-example.png#gh-dark-mode-only)
+![Comment example](docs/comment-example-light.png#gh-light-mode-only)
+
+## Permissions
+
+- `pull-requests: write` for writing comments on pull requests.
+- `contents: write` for the git-notes prev_coverage_mode to maintain the coverage within git notes.
+
+## Usage
+
+Just add `seriousben/go-patch-cover-action` as a step in your existing workflow.
+
+A workflow might look like this:
+
+```yaml
+name: "CI"
+
+on: ["push", "pull_request"]
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  ci:
+    name: "Run CI"
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: WillAbides/[email protected]
+      with:
+        go-version: "*"
+    - run: "go test -coverprofile=coverage.out -covermode=count ./..."
+    - uses: seriousben/[email protected]
+      with:
+        version: main
+```
+
+Please see [GitHub's documentation on Actions](https://docs.github.com/en/actions) for extensive
+documentation on how to write and tweak workflows.
+

action.yaml

@@ -1,10 +1,6 @@
 name: "Go Patch Coverage"
 description: |
   Display golang patch test coverage on your pull requests.
-
-  Required permissions:
-    - `pull-requests: write` for writing comments on pull requests.
-    - `contents: write` for the git-notes prev_coverage_mode to maintain the coverage within git notes.
 author: "Benjamin Boudreau"
 branding:
   icon: "code"
@@ -149,4 +145,4 @@ runs:
         git push origin refs/notes/coverage
       shell: bash
       env:
-        coverage_filename : ${{ inputs.coverage_filename }}
+        coverage_filename : ${{ inputs.coverage_filename }}