From eb191d481aa800376bc48e25855e7c8089ce5fbd Mon Sep 17 00:00:00 2001 From: Benjamin Lupton Date: Thu, 5 May 2011 08:56:48 +1000 Subject: [PATCH] Added package.json example --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 96bf1fc..fa3c6cd 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,23 @@ Buildr does not require any configuration by default, but if you would like to c - `src_bundle_item.js`: a file path; to the replace string for each src bundled file - `src_bundle_subpackage.js`: a file path; to the replace string for each src bundled subpackage -For reference you can refer to the [History.js](https://github.com/balupton/history.js) [package.json file](https://github.com/balupton/history.js/raw/dev/package.json) which utilises simple bundling and compression, and the [Aloha Editor](https://github.com/alohaeditor/Aloha-Editor) [package.json file](https://github.com/alohaeditor/Aloha-Editor/raw/0.10/package.json) which utilises bundling for both the src and out packages, subpackages and javascript+css+image compression. +So your `package.json` file should at least look something like this: + +``` javascript + { + "name": "my-project", + "buildr": { + "compress": true, + "bundle": true, + "directories": { + "out": "./out", + "src": "./src" + }, + "files": true + } +``` + +For further reference you can refer to the [History.js](https://github.com/balupton/history.js) [package.json file](https://github.com/balupton/history.js/raw/dev/package.json) which utilises simple bundling and compression, and the [Aloha Editor](https://github.com/alohaeditor/Aloha-Editor) [package.json file](https://github.com/alohaeditor/Aloha-Editor/raw/0.10/package.json) which utilises bundling for both the src and out packages, subpackages and javascript+css+image compression. ## License