diff options
| author | jane arc <jane@uber.com> | 2015-06-26 22:13:48 +0300 |
|---|---|---|
| committer | Rebecca Turner <me@re-becca.org> | 2015-07-01 12:41:34 +0300 |
| commit | c53d2282bd01e12cc828033d5266cdc0d8bfef3e (patch) | |
| tree | 60a39d584c1e9592db05c09aae411a9c3dce8301 | |
| parent | 21ce8fe7dfda78b5522963dc2caff080853da5e7 (diff) | |
docs: update wording for directories.bin
the wording here is a little confusing. after talking to @iarna on irc,
I am submitting this docpatch which i think describes more accurately
the use of both `directories.bin` and `bin`.
PR-URL: https://github.com/npm/npm/pull/8708
| -rw-r--r-- | doc/files/package.json.md | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/files/package.json.md b/doc/files/package.json.md index b8f543c5f..cea57e934 100644 --- a/doc/files/package.json.md +++ b/doc/files/package.json.md @@ -283,10 +283,13 @@ with the lib folder in any way, but it's useful meta info. ### directories.bin -If you specify a `bin` directory, then all the files in that folder will -be added as children of the `bin` path. +If you specify a `bin` directory in `directories.bin`, all the files in +that folder will be added. -If you have a `bin` path already, then this has no effect. +Because of the way the `bin` directive works, specifying both a +`bin` path and setting `directories.bin` is an error. If you want to +specify individual files, use `bin`, and for all the files in an +existing `bin` directory, use `directories.bin`. ### directories.man |