Add note about workaround for PhantomJS install error on some OSes to…

… README #383 [ci skip]
insin · Nov 17, 2017 · 51d92fa · 51d92fa
1 parent fcc5895
commit 51d92fa
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/CHANGES.md b/CHANGES.md
@@ -12,6 +12,10 @@
 - karma-webpack: v2.0.5 → [v2.0.6](https://github.com/webpack-contrib/karma-webpack/blob/master/CHANGELOG.md#206-2017-11-10)
 - mocha: v3.4.2 → [v4.0.1](https://github.com/mochajs/mocha/blob/master/CHANGELOG.md#401--2017-10-05) - dropped support for old versions of Node.js and non-ES5-compliant browsers
 
+## Documentation
+
+- Documented `--unsafe-perm` workaround for PhantomJS' postinstall step failing on some OSes when installing globally with npm 5 [[#383](https://github.com/insin/nwb/issues/383)]
+
 # 0.19.2 / 2017-11-09
 
 ## Fixed

diff --git a/README.md b/README.md
@@ -28,7 +28,11 @@ Installing globally provides an `nwb` command for quick development and working
 npm install -g nwb
 ```
 
-> Using **npm >= 3 is recommended**, as Babel 6 takes significantly more time and disk space to install with npm 2 due to its lack of deduplication.
+> Using **npm >= 3 is recommended**, as Babel takes significantly more time and disk space to install with npm 2 due to its lack of deduplication.
+
+> **Note:** if you're using npm 5 and getting an `EACCES: permission denied` error from nwb's PhantomJS dependency while installing globally, try passing an `--unsafe-perm` flag:
+>
+> `npm install -g --unsafe-perm nwb`
 
 To use nwb's tooling in a project, install it as a `devDependency` and use `nwb` commands in `package.json` `"scripts"`: