karma-spec-json-reporter - npm Package Compare versions

Comparing version 0.0.7 to 0.0.8

package.json

 {
   "name": "karma-spec-json-reporter",
-  "version": "0.0.7",
+  "version": "0.0.8",
   "description": "A Karma JSON reporter for specs",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,1 +0,39 @@
-# Karma JSON spec reporter
+# Karma JSON spec reporter
+
+This is a karma reporter that will export your test data in the form of JSON but keys all describe contexts such as:
+
+```
+{
+    "My Feature": {
+        "should have a passing test": "PASSED",
+        "might have a failing test": "FAILED"
+    },
+    "My Other Feature": {
+      "should also have a passing test": "PASSED"
+    }
+}
+
+
+```
+
+## Installation
+
+
+```
+npm install --save-dev karma-spec-json-reporter
+```
+
+In your `karma.conf.js` add include `'specjson'` to your reporters like below:
+
+```
+reporters: ['specjson', 'dots'],
+```
+
+You will also need to set the location that you need to output your JSON file.
+
+```
+    specjsonReporter: {
+        outputFile: "karma-specs.json"
+    }
+```
+

No alert changes

Improved metrics

Total package byte prevSize

5198

increased by15.38%

Number of lines in readme file

40

increased by3900%

No dependency changes