diff options
| author | Beau Gunderson <beau@beaugunderson.com> | 2016-01-17 22:34:32 +0300 |
|---|---|---|
| committer | Rebecca Turner <me@re-becca.org> | 2016-01-21 04:31:13 +0300 |
| commit | 3666081abd02184ba97a7cdb6ae238085d640b4b (patch) | |
| tree | b63f568ff929a69e1d34277cfe710a03906c43f9 /doc | |
| parent | ea331c82157c65f7643cd4b49fd24031c84bf601 (diff) | |
doc: briefly explain what's included
PR-URL: https://github.com/npm/npm/pull/11188
Credit: @beaugunderson
Reviewed-By: @othiym23
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cli/npm-publish.md | 9 |
1 files changed, 6 insertions, 3 deletions
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 |