summary refs log tree commit diff
path: root/pkgs/development/node-packages/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'pkgs/development/node-packages/README.md')
-rw-r--r--pkgs/development/node-packages/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/pkgs/development/node-packages/README.md b/pkgs/development/node-packages/README.md
new file mode 100644
index 000000000000..138d1475c2fe
--- /dev/null
+++ b/pkgs/development/node-packages/README.md
@@ -0,0 +1,13 @@
+Node.js packages
+===============
+To add a package from [NPM](https://www.npmjs.com/) to nixpkgs:
+
+ 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!