docs(README): Simple Usage

pinnacles · Jan 12, 2024 · cee82be · cee82be
1 parent b4648c7
commit cee82be
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,3 +2,13 @@
 
 This is a Github Action that verifies that the files generated by the go generate command are up to date.
 
+# Usage
+
+```yml
+# ...
+steps:
+  - uses: actions/checkout@v4
+  - uses: actions/setup-go@v5
+  - ... # If you have any preparation for generate, you need to prepare it.
+  - uses: pinnacles/[email protected]
+```