Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
maenu committed May 11, 2013
1 parent 80325ed commit ebdeede
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 6 deletions.
36 changes: 31 additions & 5 deletions README.md
@@ -1,13 +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)

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.
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -2,7 +2,7 @@
"name": "grunt-template-jasmine-istanbul-example",
"version": "0.5.0",
"author": {
"name": "Manuel Leuenberger"
"name": "maenu"
},
"repository": {
"type": "git",
Expand Down

0 comments on commit ebdeede

Please sign in to comment.