From f04376455dcf42bf997658ce63039882a16852b0 Mon Sep 17 00:00:00 2001 From: Max Ogden Date: Wed, 25 Mar 2015 17:56:46 -0700 Subject: [PATCH] add --save-dev instructions to readme --- npm/README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/npm/README.md b/npm/README.md index 04e7c53c90..58f9fd1c4d 100644 --- a/npm/README.md +++ b/npm/README.md @@ -10,7 +10,15 @@ Atom Shell is a javascript runtime that bundles Node.js and Chromium. You use it ## 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 @@ -52,4 +60,4 @@ console.log(atom) // spawn atom-shell var child = proc.spawn(atom) -``` \ No newline at end of file +```