Skip to content
This repository has been archived by the owner on Aug 11, 2022. It is now read-only.

Commit

Permalink
Clean up the docs further. Make them more consistent.
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacs committed Apr 26, 2010
1 parent 94069af commit 64afd3d
Show file tree
Hide file tree
Showing 15 changed files with 66 additions and 51 deletions.
4 changes: 4 additions & 0 deletions doc/activate.md
@@ -1,8 +1,12 @@
npm activate(1) -- Activate an installed version of a package
=============================================================

## SYNOPSIS

npm activate <name> <version>

## DESCRIPTION

This "activates" a specific version of a package, so that you can just do
`require("foo")` without having to specify the version.

Expand Down
4 changes: 4 additions & 0 deletions doc/adduser.md
@@ -1,8 +1,12 @@
npm adduser(1) -- Add a registry user account
=============================================

## SYNOPSIS

npm adduser bob password bob@email.com

## DESCRIPTION

Create a user named "bob" in the npm registry, and save the credentials to the
`.npmrc` file. Note that this leaves the password in your `.bash_history`, and
it is currently stored in the clear in the config file. So, don't use a
Expand Down
14 changes: 0 additions & 14 deletions doc/cli.md

This file was deleted.

11 changes: 10 additions & 1 deletion doc/config.md
@@ -1,6 +1,15 @@
npm-config(1) -- Manage the npm configuration file
==================================================

## SYNOPSIS

npm config set <key> <value>
npm config get <key>
npm config delete <key>
npm config list

## DESCRIPTION

The config command is a way to interact with the `.npmrc` file. This file is a
JSON encoded list of values that npm is concerned with. The first time you run
npm, it will create a conf file filled with default values.
Expand Down Expand Up @@ -36,7 +45,7 @@ Show all the config settings.
**FIXME**: Prints to stderr, but should really be stdout, since the log is what
you're after.

### delete key
### delete

npm config delete key

Expand Down
4 changes: 4 additions & 0 deletions doc/deactivate.md
@@ -1,8 +1,12 @@
npm-deactivate(1) -- Deactivate the active version of a package
===============================================================

## SYNOPSIS

npm deactivate <name>

## DESCRIPTION

If there's an active version of the package, this will unlink it from that
preferential position.

Expand Down
5 changes: 4 additions & 1 deletion doc/folders.md
@@ -1,4 +1,7 @@
# Folder Structures Used by npm
npm-folders(1) -- Folder Structures Used by npm
===============================================

## DESCRIPTION

Everything lives in the `root` setting. This defaults to
`$HOME/.node_libraries/`. I'd like to be able to override it, but that's not
Expand Down
2 changes: 1 addition & 1 deletion doc/help.md
@@ -1,7 +1,7 @@
npm-help(1) -- Get help about npm commands
==========================================

## Usage
## SYNOPSIS

npm help <section>

Expand Down
4 changes: 2 additions & 2 deletions doc/install.md
@@ -1,7 +1,7 @@
npm-install(1) -- install a package
===================================

## SUMMARY
## SYNOPSIS

npm install <tarball>

Expand All @@ -24,7 +24,7 @@ be automatically performed some or all of the time.

Installing by name and version alone is planned for the next version.

See also:
## SEE ALSO

* npm help config
* npm help activate
4 changes: 4 additions & 0 deletions doc/link.md
@@ -1,8 +1,12 @@
npm-link(1) -- Symlink a package folder
=======================================

## SYNOPSIS

npm link <folder>

## DESCRIPTION

This will link a source folder into npm's registry using a symlink, and then
build it according to the package.json file in that folder's root. This is
handy for installing your own stuff, so that you can work on it and test it
Expand Down
4 changes: 4 additions & 0 deletions doc/list.md
@@ -1,9 +1,13 @@
npm-list(1) -- List installed packages
======================================

## SYNOPSIS

npm list [package]
npm ls [package]

## DESCRIPTION

This will show the installed (and, potentially, activated) versions of all the
packages that npm has installed, or just the `package` if specified.

Expand Down
12 changes: 6 additions & 6 deletions doc/npm.md
@@ -1,14 +1,14 @@
npm(1) -- node package manager
==============================

## DESCRIPTION

npm is a little package manager for the Node javascript library.

## SYNOPSIS

npm <command> [args]

## DESCRIPTION

npm is a little package manager for the Node javascript library.

Run `npm help` for more details.

## STATUS: alpha
Expand Down Expand Up @@ -152,5 +152,5 @@ Some "nice to have" things that aren't quite core:
### 0.0.7

* fixed a bug in semver


* refactor documentation
* add "help" command
7 changes: 6 additions & 1 deletion doc/publish.md
@@ -1,7 +1,12 @@
npm-publish(1) -- Publish a package
===================================

npm publish http://host.com/path/to/tarball.tgz

## SYNOPSIS

npm publish <tarball-url>

## DESCRIPTION

Publishes a tarball containing a package to the npm registry.

Expand Down
33 changes: 9 additions & 24 deletions doc/registry.md
@@ -1,32 +1,17 @@
# npm registry
npm-registry(1) -- Notes on the JavaScript package registry
===========================================================

Notes on npm's use of the [js-registry](http://github.com/mikeal/js-registry).

None of this has been implemented as of 2010-03-10.

## New Commands

Add the following commands:

### publish
## MARKED FOR REMOVAL

npm publish <url>
This doc file will be removed once its contents have been implemented and its
data moved to the relevant command documentation.

Fetches the tarball from the url, checks the package.json, and sends to the
registry as the dist url. Fails if the fetch is non-200, or if the version
already exists in the registry for that package.
## npm registry

If the package is not already there, then publishing a tarball creates it.

### tag

npm tag <project> <version> <tag>

Tag a project version with a tag, anything is fine. Note that npm treats the
"stable" tag a bit differently, preferring to install that one when not given
a version.
Notes on npm's use of the [js-registry](http://github.com/mikeal/js-registry).

If the version doesn't exist, then it fails.
As of 2010-04-25, the "new commands" have been added, but the changes to the
"changed commands" have not been made yet.

## Changed commands

Expand Down
5 changes: 4 additions & 1 deletion doc/tag.md
@@ -1,12 +1,15 @@
npm-tag(1) -- Tag a published version
=====================================

## SYNOPSIS

npm tag packagename 1.2.3 tagname

## DESCRIPTION

Tags the specified version of "packagename" with the specified "tagname".

The only tag with any special significance is "stable".

When installation from the registry is supported, this will be much more
relevant.

4 changes: 4 additions & 0 deletions doc/uninstall.md
@@ -1,9 +1,13 @@
npm-uninstall(1) -- Remove a package
====================================

## SYNOPSIS

npm uninstall <name> <version>
npm rm <name> <version>

## DESCRIPTION

This uninstalls a package, completely removing everything installed for it. If
it's currently active, then it must be deactivated first. If anything is
depending on it, then those must be uninstalled first.

0 comments on commit 64afd3d

Please sign in to comment.