Permalink
Browse files

enrich readme

  • Loading branch information...
1 parent d43a98a commit c3cdf1f2be420ed5812b97ddf337271a116e760a @deniswolf deniswolf committed Jan 7, 2013
Showing with 11 additions and 0 deletions.
  1. +11 −0 README.md
View
@@ -2,12 +2,15 @@
Aggregates file groups (aka aggregations): Minifies files with include/exclude wildcards,
creates an index and debug index of the minified files, and runs lint and copy tasks.
GruntAggregator also include a modify task, which allows manipulation of file name and content
+
## Tasks
+
### aggregate task
Aggregate is a multitask, which creates multiple minified files, copies the original files (for debugging)
and creates an {index}.json file with aggregation mapping.
In addition, a {index}.debug.json if created, mapping the full, unminified version of the content.
This is useful if you're running your application in debug mode.
+
#### Usage:
```javascript
// Project configuration.
@@ -24,7 +27,9 @@ grunt.initConfig({
},
});
```
+
deployment/main.json
+
```javascript
// Project configuration.
[
@@ -46,3 +51,9 @@ deployment/main.json
]
```
+## Development
+
+### Testing
+To run test suite:
+1. Install grunt globally `npm install -g grunt`
+2. Simply run grunt `grunt` to see all tests passing

0 comments on commit c3cdf1f

Please sign in to comment.