mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

add --save-dev instructions to readme

Browse source
This commit is contained in:
Max Ogden 2015-03-25 17:56:46 -07:00
parent 7eb594d6b5
commit f04376455d
1 changed files with 10 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
npm/README.md
View file

@ -10,7 +10,15 @@ Atom Shell is a javascript runtime that bundles Node.js and Chromium. You use it
## Installation ## Installation
Download and install the latest build of atom-shell for your OS and symlink it into your PATH: Download and install the latest build of atom-shell for your OS and add it to your projects `package.json` as a `devDependency`:
```
npm install atom-shell --save-dev
```
This is the preferred way to use atom-shell, as it doesn't require users to install atom-shell globally.
You can also use the `-g` flag (global) to symlink it into your PATH:
``` ```
npm install -g atom-shell npm install -g atom-shell
@ -52,4 +60,4 @@ console.log(atom)
// spawn atom-shell // spawn atom-shell
var child = proc.spawn(atom) var child = proc.spawn(atom)
``` ```