diff --git a/README.md b/README.md index 2f06e7a..edda43a 100644 --- 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 }} +```