Skip to content

Commit

Permalink
docs(readme): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DarkGuy10 committed Jan 27, 2024
1 parent 422686d commit cdfd378
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ GitHub Actions allows you to build your app on macOS, Windows and Linux without

steps:
- name: Check out Git repository
uses: actions/checkout@v1
uses: actions/checkout@v4

- name: Install Node.js, NPM and Yarn
uses: actions/setup-node@v1
uses: actions/setup-node@v4
with:
node-version: 10
node-version: 20

- name: Build/release Electron app
uses: samuelmeuli/action-electron-builder@v1
uses: DarkGuy10/action-electron-builder@v1
with:
# GitHub token, automatically provided to the action
# (No need to define this secret in the repo settings)
Expand Down Expand Up @@ -71,6 +71,7 @@ After building successfully, the action will publish your release artifacts. By

You can configure the action further with the following options:

- `package_manager`: The package manager that should be used (accepted: `"npm"`, `"yarn"`, `"pnpm"`) (default: `"npm"`)
- `package_root`: Directory where NPM/Yarn commands should be run (default: `"."`)
- `build_script_name`: Name of the optional NPM build script which is executed before `electron-builder` (default: `"build"`)
- `skip_build`: Whether the action should execute the NPM build script before running `electron-builder`
Expand All @@ -94,7 +95,7 @@ Add the following options to your workflow's existing `action-electron-builder`

```yml
- name: Build/release Electron app
uses: samuelmeuli/action-electron-builder@v1
uses: DarkGuy10/action-electron-builder@v1
with:
# ...
mac_certs: ${{ secrets.mac_certs }}
Expand Down Expand Up @@ -144,7 +145,7 @@ If you've configured `electron-builder` to notarize your Electron Mac app [as de

```yml
- name: Build/release Electron app
uses: samuelmeuli/action-electron-builder@v1
uses: DarkGuy10/action-electron-builder@v1
with:
# ...
env:
Expand Down

0 comments on commit cdfd378

Please sign in to comment.