Update README.md

Slinet6056 · Sep 4, 2024 · 21e8561 · 21e8561
1 parent 82a2f4b
commit 21e8561
Showing 1 changed file with 28 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,29 @@
 # archpkg-build action
+
+## Example usage
+
+```yml
+uses: Slinet6056/archpkg-build@master
+with:
+  package_name: pkg
+  gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+  gpg_passphrase: ${{ secrets.GPG_PASSPHRASE }}
+  pkgs_directory: test # optional
+```
+
+## Tips
+
+### use matrix to build multi pkgs
+
+```yml
+strategy:
+  matrix:
+    pkgs: [pkg1, pkg2]
+
+steps:
+  - uses: Slinet6056/archpkg-build@master
+    with:
+      package_name: ${{ matrix.pkgs }}
+      gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
+      gpg_passphrase: ${{ secrets.GPG_PASSPHRASE }}
+```