Provide example

.github/workflows/shell.yaml

@@ -4,7 +4,7 @@ on:
   pull_request:
     paths:
       - "**.sh"
-      - ".github/workflows"
+      - ".github/workflows/*"
       - "action.yaml"
       - "gha_extract_shell_scripts.py"
 

README.md

@@ -2,6 +2,38 @@
 
 Processes the GitHub Action workflows contained within `.github/workflows` and extracts all steps which contain an embedded shell script for the purpose of running linting and formatting. Each workflow step containing a shell script will be written out to a file to make it easy to use existing tooling such as `shellcheck` and `shfmt`.
 
+## Example
+
+```yaml
+---
+name: Shell
+on:
+  pull_request:
+    paths:
+      - "**.sh"
+      - ".github/workflows/*"
+
+jobs:
+  lint-format:
+    name: Lint & Format
+    # These permissions are needed to:
+    # - Checkout the Git repo (`contents: read`)
+    # - Post a comments on PRs: https://github.com/luizm/action-sh-checker#secrets
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Extract workflow shell scripts
+        uses: beacon-biosignals/gha-extract-shell-scripts@31fbf16b19d1b371dc60be09c94df15bfb1b5fdf
+      - uses: luizm/action-sh-checker@c6edb3de93e904488b413636d96c6a56e3ad671a  # v0.8.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          sh_checker_comment: true
+```
+
 ## Inputs
 
 The `gha-extract-shell-scripts` action supports the following inputs: