Navigation Menu

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

Commit

Permalink
Updates for publish command
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacs committed May 10, 2010
1 parent c94ccd5 commit f5e7e9c
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 9 deletions.
16 changes: 12 additions & 4 deletions doc/publish.md
Expand Up @@ -4,11 +4,19 @@ npm-publish(1) -- Publish a package

## SYNOPSIS

npm publish <tarball-url>
npm publish <tarball>
npm publish <folder>

## DESCRIPTION

Publishes a tarball containing a package to the npm registry.
Publishes a package to the registry so that it can be installed by name.

When installation from the registry is supported, this will be much more
relevant.
* `<folder>`:
A folder containing a package.json file

* `<tarball>`:
A url or file path to a gzipped tar archive containing a single folder
with a package.json file inside.

Fails if the package name and version combination already exists in
the registry.
20 changes: 15 additions & 5 deletions man/publish.1
@@ -1,21 +1,31 @@
.\" generated with Ronn/v0.4.1
.\" http://github.com/rtomayko/ronn/
.
.TH "NPM\-PUBLISH" "1" "April 2010" "" ""
.TH "NPM\-PUBLISH" "1" "May 2010" "" ""
.
.SH "NAME"
\fBnpm\-publish\fR \-\- Publish a package
.
.SH "SYNOPSIS"
.
.nf
npm publish <tarball\-url>
npm publish <tarball>
npm publish <folder>
.
.fi
.
.SH "DESCRIPTION"
Publishes a tarball containing a package to the npm registry.
Publishes a package to the registry so that it can be installed by name.
.
.TP
\fB<folder>\fR
A folder containing a package.json file
.
.TP
\fB<tarball>\fR
A url or file path to a gzipped tar archive containing a single folder
with a package.json file inside.
.
.P
When installation from the registry is supported, this will be much more
relevant.
Fails if the package name and version combination already exists in
the registry.

0 comments on commit f5e7e9c

Please sign in to comment.