Skip to content
Browse files

Added License and README files

  • Loading branch information...
1 parent d09db57 commit 6a364a08044c8a6818e550991b3cdae2fd22250f @davglass committed Jul 10, 2012
Showing with 103 additions and 0 deletions.
  1. +30 −0 LICENSE
  2. +73 −0 README.md
View
30 LICENSE
@@ -0,0 +1,30 @@
+Software License Agreement (BSD License)
+
+Copyright (c) 2012, Dav Glass <davglass@gmail.com>.
+All rights reserved.
+
+Redistribution and use of this software in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above
+ copyright notice, this list of conditions and the
+ following disclaimer.
+
+* Redistributions in binary form must reproduce the above
+ copyright notice, this list of conditions and the
+ following disclaimer in the documentation and/or other
+ materials provided with the distribution.
+
+* The name of Dav Glass may not be used to endorse or promote products
+ derived from this software without specific prior
+ written permission of Dav Glass.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
View
73 README.md
@@ -0,0 +1,73 @@
+## LCOV file parser
+
+Simple LCOV file parser
+
+## Installation
+
+ npm install lcov-parser
+
+
+## Usage
+
+ var parse = require('lcov-parser');
+
+ parse('./path/to/file.info', function(err, data) {
+ //process the data here
+ });
+
+## Formatting
+
+Using this as a guide: http://ltp.sourceforge.net/coverage/lcov/geninfo.1.php
+
+It will return JSON like this:
+
+```
+ {
+ "title": "Test #1",
+ "file": "anim-base/anim-base-coverage.js",
+ "functions": {
+ "hit": 23,
+ "found": 29,
+ "details": [
+ {
+ "name": "(anonymous 1)",
+ "line": 7,
+ "hit": 6
+ },
+ {
+ "name": "(anonymous 2)",
+ "line": 620,
+ "hit": 225
+ },
+ {
+ "name": "_end",
+ "line": 516,
+ "hit": 228
+ }
+ ]
+ }
+ "lines": {
+ "found": 181,
+ "hit": 143,
+ "details": [
+ {
+ "line": 7,
+ "hit": 6
+ },
+ {
+ "line": 29,
+ "hit": 6
+ }
+ ]
+ }
+}
+```
+
+## Tests
+
+ npm install && npm test
+
+
+## Build Status
+
+[![Build Status](https://secure.travis-ci.org/davglass/lcov-parser.png?branch=master)](http://travis-ci.org/davglass/lcov-parser)

0 comments on commit 6a364a0

Please sign in to comment.
Something went wrong with that request. Please try again.