Update README.md

SPHTech-Platform · Sep 17, 2023 · 7affbba · 7affbba
1 parent e6ed6a2
commit 7affbba
Showing 1 changed file with 11 additions and 1 deletion.
diff --git 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 }}
+```