Skip to content

Commit 721170b

Browse files
committed
docs: don't recommend installing globally
1 parent c99d986 commit 721170b

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,11 @@ It generates executables/bundles for the following **target** platforms:
5555
This module requires Node.js 10.0 or higher to run.
5656

5757
```sh
58-
# For use in npm scripts (recommended)
59-
npm install electron-packager --save-dev
60-
61-
# For use from the CLI
62-
npm install electron-packager -g
58+
npm install --save-dev electron-packager
6359
```
6460

61+
It is **not** recommended to install `electron-packager` globally.
62+
6563
### Building Windows apps from non-Windows platforms
6664

6765
Building an Electron app for the Windows target platform requires editing the `Electron.exe` file.
@@ -77,12 +75,15 @@ JavaScript API usage can be found in the [API documentation](https://electron.gi
7775

7876
### From the Command Line
7977

80-
Running electron-packager from the command line has this basic form:
78+
Running Electron Packager from the command line has this basic form:
8179

8280
```
83-
electron-packager <sourcedir> <appname> --platform=<platform> --arch=<arch> [optional flags...]
81+
npx electron-packager <sourcedir> <appname> --platform=<platform> --arch=<arch> [optional flags...]
8482
```
8583

84+
**Note**: `npx` can be substituted for `yarn` or `npm exec` depending on what package manager and
85+
the version you have installed.
86+
8687
This will:
8788

8889
- Find or download the correct release of Electron
@@ -127,15 +128,15 @@ foobar
127128

128129
…and that the following is true:
129130

130-
* `electron-packager` is installed globally
131+
* `electron-packager` is installed locally
131132
* `productName` in `package.json` has been set to `Foo Bar`
132133
* The `electron` module is in the `devDependencies` section of `package.json`, and set to the exact version of `1.4.15`.
133134
* `npm install` for the `Foo Bar` app has been run at least once
134135

135136
When one runs the following command for the first time in the `foobar` directory:
136137

137138
```
138-
electron-packager .
139+
npx electron-packager .
139140
```
140141

141142
`electron-packager` will do the following:

0 commit comments

Comments
 (0)