Permalink
Browse files

make doc

  • Loading branch information...
isaacs committed Aug 23, 2010
1 parent 6c3bf71 commit c5288e31d409b86d0324e8ebc3ef7e46dbe79003
Showing with 31 additions and 18 deletions.
  1. +7 −3 man/folders.1
  2. +7 −14 man/json.1
  3. +17 −1 man/npm.1
View
@@ -23,13 +23,17 @@ foo\. This is a shim, not a symbolic link, so that relative paths will work
appropriately\.
.
.P
-\fBroot/\.npm/foo/active\fR symlink to the active version\.
+\fBroot/foo\-1\.0\.0/{module\-name}\.js\fR Generated shim corresponding to a module
+defined in the modules option\. The module shim requires \fBroot/\.npm/foo/1\.0\.0/package/{module\-path}\.js\fR
+.
+.P
+The \fBmain\fR script is implemented by creating an \fBindex\.js\fR file in this folder\.
.
.P
-\fBroot/foo\-1\.0\.0\.js\fR shim to \fB\|\.npm/foo/1\.0\.0/main\.js\fR
+\fBroot/foo/\fR Symlink to the active version\'s module folder\.
.
.P
-\fBroot/foo\.js\fR shim to \fB\|\.npm/foo/active/main\.js\fR
+\fBroot/\.npm/foo/active\fR symlink to the active version\.
.
.P
\fBroot/\.npm/foo/1\.0\.0/dependencies\fR links to the modules that foo depends upon\.
View
@@ -77,22 +77,15 @@ This should be a module ID relative to the root of your package folder\.
.P
For most modules, it makes the most sense to have a main script\.
.
-.SH "directories"
-The "directories" member is an object hash of folders\.
-.
-.SS "directories\.lib"
-The only directory that npm cares about is the "lib" directory\. This is a folder
-that will be mapped to the package name\. So, if you had a package named \fBfoo\fR,
-and the package\.json contains \fB"directories":{"lib":"\./lib"}\fR, and there was
-a file called \fB\|\./lib/bar\.js\fR, then require("foo/bar") would include that module\.
-.
-.P
-This is handy if your package is a collection or library full of useful goodies\.
-However, dependency paths are not corrected for modules in the lib folder, so it\'s
-a bit more complicated\.
+.SH "modules"
+The "modules" member exposes CommonJS modules in the package\. So, if you had a
+package named \fBfoo\fR, and the package\.json contains \fB"modules":{"bar":"\./lib/baz"}\fR,
+and there was a file called \fB\|\./lib/baz\.js\fR, then require("foo/bar") would include
+the module defined in \fB\|\./lib/baz\.js\fR\|\.
.
.P
-Most of the time, delving into a package\'s folder is not as awesome\.
+Just like the \fBmain\fR script, the modules linked in this fashion will have their
+dependencies and paths set up properly by npm\.
.
.SH "scripts"
The "scripts" member is an object hash of script commands that are run
View
@@ -341,7 +341,7 @@ Cascading configs: cli, env, user, global
First pass at \fBnpm view\fR command
.
.IP "\(bu" 4
-0\.1\.24:
+0\.1\.24, 0\.1\.25:
Fix a bunch of things
.
.br
@@ -350,5 +350,21 @@ Cleanup, etc\.
.br
help via \-\-help, \-h, or \-?
.
+.IP "\(bu" 4
+0\.1\.26:
+"modules" hash in package\.json (Alex K\. Wolfe)
+.
+.br
+Better "restart" command (Alex K Wolfe)
+.
+.br
+Work on Cygwin
+.
+.br
+Remove link packages properly
+.
+.br
+Make several commands more parallel
+.
.IP "" 0

0 comments on commit c5288e3

Please sign in to comment.