cucumber-json-merge - npm Package Compare versions

Comparing version 0.0.7 to 0.0.8

CHANGELOG.md

@@ -13,1 +13,4 @@ # Changelog
 
+### 0.0.8
+
+Ability to use cucumber-json-merge right from nodejs code, as a library.

package.json

 {
   "name": "cucumber-json-merge",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "NodeJS CLI for merging Cucumber JSON test results",
-  "main": "index.js",
+  "main": "./lib/index.js",
   "bin": "./bin/cucumber-json-merge",
@@ -13,3 +13,3 @@ "directories": {
     "fs-readdir-recursive": "^1.1.0",
-    "mkdirp": "^0.5.5"
+    "mkdirp": "^0.5.6"
   },
@@ -16,0 +16,0 @@ "devDependencies": {

README.md

 # cucumber-json-merge
 
+[![NPM version](https://img.shields.io/npm/v/cucumber-json-merge.svg)](https://www.npmjs.com/package/cucumber-json-merge) [![License](https://img.shields.io/github/license/bitcoder/cucumber-json-merge.svg)](https://github.com/bitcoder/cucumber-json-merge/blob/master/LICENSE)
 [![Coverage Status](https://coveralls.io/repos/github/bitcoder/cucumber-json-merge/badge.svg?branch=master)](https://coveralls.io/github/bitcoder/cucumber-json-merge?branch=master)
+[![CI status](https://img.shields.io/github/workflow/status/bitcoder/cucumber-json-merge/CI-CD?label=CI&style=flat-square)](https://github.com/bitcoder/cucumber-json-merge/actions?query=workflow%3ACI-CD)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
 [![Known Vulnerabilities](https://snyk.io/test/github/bitcoder/cucumber-json-merge/badge.svg)](https://snyk.io/test/github/bitcoder/cucumber-json-merge)
+[![NPM downloads](https://img.shields.io/npm/dw/cucumber-json-merge.svg)](https://www.npmjs.com/package/cucumber-json-merge)
 
@@ -29,9 +32,29 @@ ## NodeJS CLI for merging Cucumber JSON test results
     -r, --recursive         pass to recursively merge all results in directory
-    -o, --out <mergedfile>  file to output to (default: ./merged-test-results.xml)
+    -o, --out <mergedfile>  file to output to (default: ./merged-test-results.json)
     -h, --help              output usage information
 ```
 
-### Contributing
+### Advanced usage: including this as a library
 
+In case you want to run this right from within nodeJS code, you should be able to include it as a library and perform the operations you want.
+
+```javascript
+cukemerge = require('cucumber-json-merge');
+
+files = cukemerge.listJsonFiles('.', false);
+merged = cukemerge.mergeFiles(files);
+console.log(merged);
+```
+
+## Contributing
+
 Feel free to submit issues and/or PRs!  In lieu of a formal style guide, 
 please follow existing styles.
+
+## Contact
+
+You can find me on [Twitter](https://twitter.com/darktelecom).
+
+## LICENSE
+
+[Apache 2.0](LICENSE).

No alert changes

Improved metrics

Total package byte prevSize

40263

increased by7.59%

Number of package files

19

increased by5.56%

Number of lines in readme file

60

increased by62.16%

Dependency changes

• Updatedmkdirp@^0.5.6