docs for npm build

1 files changed, 25 insertions, 0 deletions

diff --git a/doc/build.md b/doc/build.md
new file mode 100644
index 000000000..e4675610d
--- /dev/null
+++ b/doc/build.md
@@ -0,0 +1,25 @@
+npm-build(1) -- Build a package
+===============================
+
+## SYNOPSIS
+
+    npm build <package-folder>
+
+* <package-folder>:
+  A folder containing a `package.json` file in its root.
+
+## DESCRIPTION
+
+This command should almost never need to be run directly.  It is an abstraction
+of the functionality shared by both npm-install(1) and npm-link(1).
+
+This command creates the various interwoven links that ensure a package's contents
+are available in the root appropriately, and that its dependencies are linked
+appropriately.
+
+See also:
+
+* npm-install(1)
+* npm-link(1)
+* npm-scripts(1)
+* npm-json(1)