diff options
author | isaacs <i@izs.me> | 2010-05-05 11:49:43 +0400 |
---|---|---|
committer | isaacs <i@izs.me> | 2010-05-05 11:49:56 +0400 |
commit | 56e4f8f2fe2c38814a09f4a69a717d92ae6b6595 (patch) | |
tree | fff8dbe183ba2dc773d6435e72a79d3f27bf0ca6 /doc | |
parent | d049393548ed19034399a749c3fed2f52ee4f3e9 (diff) |
documentation updates and cleanup
Diffstat (limited to 'doc')
-rw-r--r-- | doc/build.md | 2 | ||||
-rw-r--r-- | doc/help.md | 2 | ||||
-rw-r--r-- | doc/install.md | 14 | ||||
-rw-r--r-- | doc/npm.md | 5 |
4 files changed, 14 insertions, 9 deletions
diff --git a/doc/build.md b/doc/build.md index c374e80b2..4e11efb77 100644 --- a/doc/build.md +++ b/doc/build.md @@ -5,7 +5,7 @@ npm-build(1) -- Build a package npm build <package-folder> -* <package-folder>: +* `<package-folder>`: A folder containing a `package.json` file in its root. ## DESCRIPTION diff --git a/doc/help.md b/doc/help.md index 4712430df..024ba3101 100644 --- a/doc/help.md +++ b/doc/help.md @@ -5,7 +5,7 @@ npm-help(1) -- Get help about npm commands npm help <section> -Where <section> is one of: +Where `<section>` is one of: `activate`, `adduser`, `build`, `config`, `deactivate`, `folders`, `help` (this page), `install`, `json`, `link` (or `ln`), `list` (or `ls`), `npm`, `publish`, `registry`, `scripts`, `tag`, `uninstall` (or `rm`) diff --git a/doc/install.md b/doc/install.md index e749b4440..657334ebb 100644 --- a/doc/install.md +++ b/doc/install.md @@ -15,7 +15,7 @@ npm-install(1) -- install a package This command installs a package, and any packages that it depends on. It resolves circular dependencies by talking to the npm registry. -* npm install <tarball file>: +* npm install `<tarball file>`: Install a package that is sitting on the filesystem. Note: if you just want to link a dev directory into your npm root, you can do this more easily by using `npm link`. @@ -27,7 +27,7 @@ resolves circular dependencies by talking to the npm registry. npm install ./package.tgz -* npm install <tarball url>: +* npm install `<tarball url>`: Fetch the tarball url, and then install it. In order to distinguish between this and other options, the argument must start with "http://" or "https://" @@ -35,15 +35,15 @@ resolves circular dependencies by talking to the npm registry. npm install http://github.com/waveto/node-crypto/tarball/v0.0.5 -* npm install <pkg>: - Do a <pkg>@<tag> install, where <tag> is the "tag" config from either your +* npm install `<pkg>`: + Do a `<pkg>@<tag>` install, where `<tag>` is the "tag" config from either your .npmrc file, or the --tag argument on the command line. Example: npm install sax -* npm install <pkg>@<tag>: +* npm install `<pkg>@<tag>`: Install the version of the package that is referenced by the specified tag. If the tag does not exist in the registry data for that package, then this will fail. @@ -52,7 +52,7 @@ resolves circular dependencies by talking to the npm registry. npm install sax@stable -* npm install <pkg>@<version>: +* npm install `<pkg>@<version>`: Install the specified version of the package. This will fail if the version has not been published to the registry. @@ -60,7 +60,7 @@ resolves circular dependencies by talking to the npm registry. npm install sax@0.1.1 -* npm install <pkg>@<version range>: +* npm install `<pkg>@<version range>`: Install a version of the package matching the specified version range. This will follow the same rules for resolving dependencies described in `npm help json`. diff --git a/doc/npm.md b/doc/npm.md index ca7ec5962..426edb4a8 100644 --- a/doc/npm.md +++ b/doc/npm.md @@ -139,6 +139,11 @@ i@izs.me. Fixed DOA bugs Removed dependence on ronn +* 0.1.3: + Changed a few details with configs (fix #5) + Update adduser and publish to put author info in the data + Use buffer api for file writes, hopefully fix #4 + ## SEE ALSO npm-help(1) |