Clarify usage of bundledDependencies

john-osullivan · isaacs · commit f5857e263ccf · 2019-06-29T20:23:54.000-07:00
I spent a couple hours debugging the fact that package names in that key aren't supposed to include their versions!  Assumed that it would need to have the same syntax as when running `npm install`.  Thought this would be a good contribution for future readers.
diff --git a/doc/files/package.json.md b/doc/files/package.json.md
@@ -648,7 +648,8 @@ If we define a package.json like this:
 we can obtain `awesome-web-framework-1.0.0.tgz` file by running `npm pack`.
 This file contains the dependencies `renderized` and `super-streams` which
 can be installed in a new project by executing `npm install
-awesome-web-framework-1.0.0.tgz`.
+awesome-web-framework-1.0.0.tgz`.  Note that the package names do not include
+any versions, as that information is specified in `dependencies`.
 
 If this is spelled `"bundleDependencies"`, then that is also honored.
 
