Skip to content

Commit

Permalink
doc: briefly explain what's included
Browse files Browse the repository at this point in the history
PR-URL: npm#11188
Credit: @beaugunderson
Reviewed-By: @othiym23
  • Loading branch information
beaugunderson authored and iarna committed Jan 21, 2016
1 parent ea331c8 commit 3666081
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions doc/cli/npm-publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,12 @@ npm-publish(1) -- Publish a package

## DESCRIPTION

Publishes a package to the registry so that it can be installed by name. See
`npm-developers(7)` for details on what's included in the published package, as
well as details on how the package is built.
Publishes a package to the registry so that it can be installed by name. All
files in the package directory are included if no local `.gitignore` or
`.npmignore` file exists. If both files exist and a file is ignored by
`.gitignore` but not by `.npmignore` then it will be included. See
`npm-developers(7)` for full details on what's included in the published
package, as well as details on how the package is built.

By default npm will publish to the public registry. This can be overridden by
specifying a different default registry or using a `npm-scope(7)` in the name
Expand Down

0 comments on commit 3666081

Please sign in to comment.