Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updates for publish command

  • Loading branch information...
commit f5e7e9c8c82e3301317d4b3af379dd7d7545e7a0 1 parent c94ccd5
@isaacs isaacs authored
Showing with 27 additions and 9 deletions.
  1. +12 −4 doc/publish.md
  2. +15 −5 man/publish.1
View
16 doc/publish.md
@@ -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.
View
20 man/publish.1
@@ -1,7 +1,7 @@
.\" 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
@@ -9,13 +9,23 @@
.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.
Please sign in to comment.
Something went wrong with that request. Please try again.