From cd343b76c7ed7405e97afd2cf5e699d5de657f4e Mon Sep 17 00:00:00 2001
From: Langston Barrett <langston.barrett@gmail.com>
Date: Thu, 15 Sep 2016 17:54:22 +0000
Subject: [PATCH] nixpkgs docs: improve node packages documentation

 * be more specific about paths to files
---
 pkgs/development/node-packages/README    | 13 -------------
 pkgs/development/node-packages/README.md | 11 +++++++++++
 2 files changed, 11 insertions(+), 13 deletions(-)
 delete mode 100644 pkgs/development/node-packages/README
 create mode 100644 pkgs/development/node-packages/README.md

diff --git a/pkgs/development/node-packages/README b/pkgs/development/node-packages/README
deleted file mode 100644
index 48354324a053..000000000000
--- a/pkgs/development/node-packages/README
+++ /dev/null
@@ -1,13 +0,0 @@
-How to update the NPM packages
-==============================
-- Install node2nix:
-
-nix-env -f '<nixpkgs>' -iA node2nix
-
-- Modify node-packages.json, add, update or remove package entries
-
-- Run the script:
-
-sh generate.sh
-
-- Done!
diff --git a/pkgs/development/node-packages/README.md b/pkgs/development/node-packages/README.md
new file mode 100644
index 000000000000..d1820e765b9b
--- /dev/null
+++ b/pkgs/development/node-packages/README.md
@@ -0,0 +1,11 @@
+NPM packages
+===========
+ 1. Install node2nix: `nix-env -f '<nixpkgs>' -iA node2nix`.
+ 2. Modify `pkgs/development/node-packages/node-packages.json`, to add, update,
+    or remove package entries.
+ 3. Run the script: `cd pkgs/development/node-packages && sh generate.sh`.
+ 4. Build your new package to test your changes: `cd /path/to/nixpkgs &&
+   nix-build -A nodePackages.<new-or-updated-package>`. To build against a
+   specific node.js version (e.g. 5.x): `nix-build -A
+   nodePackages_5_x.<new-or-updated-package>`
+ 5. Add, commit, and share your changes!