Skip to content

Commit

Permalink
documentation updates
Browse files Browse the repository at this point in the history
documentation updates
  • Loading branch information
Nathan Boyd committed May 15, 2015
1 parent 0966033 commit 2e3b912
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,23 @@
# report-generator

[![Build Status](https://travis-ci.org/nathan-boyd/report-generator.svg?branch=master)](https://travis-ci.org/nathan-boyd/report-generator) [![Coverage Status](https://coveralls.io/repos/nathan-boyd/report-generator/badge.svg?branch=master)](https://coveralls.io/r/nathan-boyd/report-generator?branch=master)

[![Sauce Test Status](https://saucelabs.com/browser-matrix/nathan-boyd.svg?auth=9459ca78bd664316a0cf84e43a98658a)](https://saucelabs.com/u/nathan-boyd)

report-generator encapsulates the task of creating simple html reports.

##quick example
```javascript

var generator new reportGenerator('report.html', ['col1', 'col2'], function (err) {
assert(err === null);
});

generator.writeRow(['cell1', 'cell2'], function (err) {
assert(err === null);
});

generator.closeReport(function(err){
assert(err === null);
});
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "report-generator",
"version": "1.0.0",
"description": "generates html reports ",
"main": "app.js",
"main": "./lib/report-generator",
"scripts": {
"test": "grunt mochaTest:test",
"coverage": "`npm bin`/istanbul cover ./test/test.js",
Expand Down

0 comments on commit 2e3b912

Please sign in to comment.