Skip to content

Commit

Permalink
Added package.json example
Browse files Browse the repository at this point in the history
  • Loading branch information
balupton committed May 4, 2011
1 parent 225a20d commit eb191d4
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Expand Up @@ -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
Expand Down

0 comments on commit eb191d4

Please sign in to comment.