Permalink
Browse files

updated readme

  • Loading branch information...
1 parent 74453a9 commit d8f5bb64a37251cbd4dff5ed95adf8b2f21753ef @maenu committed May 11, 2013
Showing with 34 additions and 7 deletions.
  1. +3 −0 Gruntfile.js
  2. +30 −6 README.md
  3. +1 −1 package.json
View
@@ -30,6 +30,9 @@ module.exports = function(grunt) {
options: {
dir: '<%= meta.bin.coverage %>/cobertura'
}
+ },
+ {
+ type: 'text-summary'
}
]
}
View
@@ -1,15 +1,39 @@
-# What is this?
+# [grunt-template-jasmine-istanbul](https://github.com/maenu/grunt-template-jasmine-istanbul) Examples
-Example application to show how to use
-[grunt-template-jasmine-istanbul](https://github.com/maenu/grunt-template-jasmine-istanbul).
+There are multiple branches, each of which is an isolated example of how to use `grunt-template-jasmine-istanbul`.
+
+Every example runs tests and generates coverage reports.
+Just run:
-To get the coverage reports, download this repo and run:
```bash
npm install
grunt test:coverage
```
+
and the coverage reports will appear in `bin/coverage/index.html`.
-Have a look at the [Gruntfile.js](Gruntfile.js) for an example configuration.
+Have a look at the [Gruntfile.js](Gruntfile.js) for the example configuration.
+
+## Examples
+
+### [**Simple**](https://github.com/maenu/grunt-template-jasmine-istanbul-example/tree/master)
+
+Shows a simple configuration without further dependencies and shows how to set up reports.
+
+### [**Connect**](https://github.com/maenu/grunt-template-jasmine-istanbul-example/tree/connect)
+
+Uses `grunt-contrib-connect` to run the test on an ad-hoc server.
+
+### [**Simple RequireJS**](https://github.com/maenu/grunt-template-jasmine-istanbul-example/tree/requirejs)
+
+Uses `grunt-template-jasmine-requirejs` to run the test on with RequireJS.
+
+### [**Complex RequireJS I**](https://github.com/maenu/grunt-template-jasmine-istanbul-example/tree/requirejs-client)
+
+Uses `grunt-template-jasmine-requirejs` to run the test on with RequireJS, but this time doesn't screw up the RequireJS configuration by overriding the `baseUrl` option.
+Instead, this example redirects requests that should point to instrumented sources on the **client** side.
+
+### [**Complex RequireJS II**](https://github.com/maenu/grunt-template-jasmine-istanbul-example/tree/requirejs-server)
-On the branches are other examples [using RequireJS](https://github.com/maenu/grunt-template-jasmine-istanbul-example/tree/requirejs) and [using an ad-hoc server](https://github.com/maenu/grunt-template-jasmine-istanbul-example/tree/connect).
+Uses `grunt-template-jasmine-requirejs` to run the test on with RequireJS, but this time doesn't screw up the RequireJS configuration by overriding the `baseUrl` option.
+Instead, this example redirects requests that should point to instrumented sources on the **server** side.
View
@@ -2,7 +2,7 @@
"name": "grunt-template-jasmine-istanbul-example",
"version": "0.5.0",
"author": {
- "name": "Manuel Leuenberger"
+ "name": "maenu"
},
"repository": {
"type": "git",

0 comments on commit d8f5bb6

Please sign in to comment.