Skip to content

Commit

Permalink
docs: update installation instructions (#317)
Browse files Browse the repository at this point in the history
  • Loading branch information
erickzhao authored May 15, 2024
1 parent 4e9ffce commit fdab709
Showing 1 changed file with 6 additions and 12 deletions.
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,16 @@ Codesign Electron macOS apps

## Installation

```sh
# For use in npm scripts
npm install --save @electron/osx-sign
# yarn
yarn add @electron/osx-sign
```
`@electron/osx-sign` is integrated into other Electron packaging tools, and can be configured accordingly:
* [Electron Packager](https://electron.github.io/packager/main/types/OsxSignOptions.html)
* [Electron Forge](https://www.electronforge.io/guides/code-signing/code-signing-macos)

You can also install `@electron/osx-sign` separately if your packaging pipeline does not involve those tools:

```sh
# For use from CLI
npm install -g @electron/osx-sign
# Yarn
yarn global add @electron/osx-sign
npm install --save-dev @electron/osx-sign
```

*Note: `@electron/osx-sign` is a dependency of [`@electron/packager`](https://github.com/electron/packager) as of 6.0.0 for signing apps on macOS. However, feel free to install this package globally for more customization beyond specifying identity and entitlements.*

## Usage

### Code Signing
Expand Down

0 comments on commit fdab709

Please sign in to comment.