diff --git a/README.md b/README.md index 71b5478..792299a 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,14 @@ This action runs pre-commit autoupdate command to update the versions in the pre-commit yaml file and makes a PR to the repo for updates -# Example usage soon +# Example usage + +Insert into part of the steps workflow + +```yaml +steps: + - uses: SPHTech-Platform/gha-pre-commit-autoupdate@main + name: Update pre-commit config automatically + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} +```