diff --git a/HISTORY.md b/HISTORY.md index 0d5ff9f..f9fd377 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -3,6 +3,8 @@ Locator Change History # @NEXT@ +# 0.3.8 + * Add support for custom names for each package bundle thru the `locator.name` entry in `package.json` (pr #20) # 0.3.7 diff --git a/README.md b/README.md index 9c2a30b..c407db3 100644 --- a/README.md +++ b/README.md @@ -136,6 +136,19 @@ locator.parseBundle(__dirname).then(function() { }); ``` +## Example: Defining Your Own Bundle Name +In your app's `package.json`: +```javascript +{ + "name": "usually-a-long-name-for-npm" + "locator": { + "name": "foo" + } +} +``` + +By default, locator will select the name of the bundle from the `package.json->name` entry, but you should be able to specify a custom name by adding a `name` entry under the `locator` entry in package.json. This will help to decouple the name of the package from the urls that you will use to fetch those scripts from the client side. + ## License This software is free to use under the Yahoo! Inc. BSD license. diff --git a/package.json b/package.json index 42a4667..27cef17 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "locator", "description": "gives semantic meaning to filesystem paths", - "version": "0.3.7", + "version": "0.3.8", "homepage": "https://github.com/yahoo/locator", "keywords": [ "filesystem",