From 3666081abd02184ba97a7cdb6ae238085d640b4b Mon Sep 17 00:00:00 2001 From: Beau Gunderson Date: Sun, 17 Jan 2016 11:34:32 -0800 Subject: doc: briefly explain what's included PR-URL: https://github.com/npm/npm/pull/11188 Credit: @beaugunderson Reviewed-By: @othiym23 --- doc/cli/npm-publish.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'doc') diff --git a/doc/cli/npm-publish.md b/doc/cli/npm-publish.md index fcef100ff..4ffefb882 100644 --- a/doc/cli/npm-publish.md +++ b/doc/cli/npm-publish.md @@ -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 -- cgit v1.2.3