Skip to content

Commit

Permalink
Fix usage example
Browse files Browse the repository at this point in the history
  • Loading branch information
tobilg committed May 11, 2020
1 parent f67b409 commit a884649
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
8 changes: 7 additions & 1 deletion README.md
Expand Up @@ -2,10 +2,16 @@

Parse [clover](https://www.atlassian.com/software/clover) report files, and return a JSON representation in a [lcov-parse](https://github.com/davglass/lcov-parse) compatible manner.

## Installation

```bash
$ npm i @cvrg-report/clover-json --save
```

## Usage

```javascript
var clover = require( "clover-json" );
var clover = require("@cvrg-report/clover-json");

// Parse by file path
clover.parseFile("filepath.xml")
Expand Down
2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "@cvrg-report/clover-json",
"version": "0.3.1",
"version": "0.3.2",
"description": "Parse clover XML coverage reports to JSON, using the same format as lcov-parse",
"keywords": [
"coverage",
Expand Down

0 comments on commit a884649

Please sign in to comment.