diff options
author | isaacs <i@izs.me> | 2010-08-25 04:25:55 +0400 |
---|---|---|
committer | isaacs <i@izs.me> | 2010-08-25 16:21:51 +0400 |
commit | 4197b4d126ea390bf71ad4d66eae46231b5d626b (patch) | |
tree | 95f3a985613251364c4e25758b648e6e9d4b8763 | |
parent | 9ad60abc66ea413c2a8da5b946456fe4ad746701 (diff) |
Add documentation for "bin" directory behavior.
-rw-r--r-- | doc/json.md | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/doc/json.md b/doc/json.md index 43e75cd3d..e308d24c1 100644 --- a/doc/json.md +++ b/doc/json.md @@ -174,12 +174,18 @@ In the future, this information may be used in other creative ways. If you specify a "lib" directory, and do not supply a modules hash, then the lib folder will be walked and any *.js or *.node files found will be exposed as a -default module hash. This is to provide backwards compatibility for packages that -may have relied on this functionality when the lib folder was symlinked directly. +default module hash. Providing an explicit modules hash is encouraged over exposing the entire lib folder. +### directories.bin + +If you specify a "bin" directory, then all the files in that folder will be used +as the "bin" hash. + +If you have a "bin" hash already, then this has no effect. + ## repository Specify the place where your code lives. This is helpful for people who want to |