Updated the README

Author: Marc Rooding

README.md

@@ -1,10 +1,11 @@
 # gulp-protractor-cucumber-html-report
 
-> Generate html report from JSON file returned by cucumber js json formatter
-> 
+> Generate html report from JSON file returned by CucumberJS json formatter
+
+This is a stand-alone fork from [grunt-protractor-cucumber-html-report](https://github.com/robhil/grunt-protractor-cucumber-html-report)
 
 ## Getting Started
-This plugin requires Grunt `~3.9.0`
+This plugin requires Gulp `~3.9.0`
 
 If you haven't used [Gulp](http://gulpjs.com/) before, be sure to check out the [Getting Started](https://github.com/gulpjs/gulp/blob/master/docs/getting-started.md) guide, as it explains how to create a Gulpfile as well as install and use Gulp plugins. Once you're familiar with that process, you may install this plugin with this command:
 
@@ -21,30 +22,59 @@ var reporter = require('gulp-protractor-cucumber-html-report');
 ## The "protractor-cucumber-html-report" task
 
 ### Overview
-In your project's Gulpfile, add a section named `protractor-cucumber-html-report` to the data object passed into `grunt.initConfig()`.
+In your project's Gulpfile, you can use the reporter in your pipeline as follows:
 
 ```js
-grunt.initConfig({
-  protractor_cucumber_html_report: {
-    options: {
-      // Task-specific options go here.
-    },
-    your_target: {
-      // Target-specific options go here.
-    },
-  },
-});
+gulp.src('./cucumber-test-results.json')
+    .pipe(protractorReport({
+        dest: 'reports/'
+    }));
 ```
 
+### Saving CucumberJS json to disk when using Protractor
+If you're using Protractor in combination with CucumberJS there currently is [no way](https://github.com/cucumber/cucumber-js/issues/90) to save the CucumberJS JSON output to a file. 
+ 
+It is however possible to add a listener to the CucumberJS JSON formatter and save it to a file manually. The following hook can be added to your project and included to your Protractor configuration.
+
+```js
+module.exports = function JsonOutputHook() {
+  var Cucumber = require('cucumber');
+  var JsonFormatter = Cucumber.Listener.JsonFormatter();
+  var fs = require('fs');
+  var path = require('path');
+
+  JsonFormatter.log = function (json) {
+    fs.writeFile(path.join(__dirname, './reports/cucumber-test-results.json'), json, function (err) {
+      if (err) throw err;
+      console.log('json file location: ' + path.join(__dirname, './reports/cucumber-test-results.json'));
+    });
+  };
+
+  this.registerListener(JsonFormatter);
+};
+```
+
+Above snippet will hook into the CucumberJS JSON formatter and save the JSON to a file called 'cucumber-test-results.json' in the ./reports folder (relative from this file's location)/
+
+### Setting up Protractor, CucumberJS and the JSON listener
+
+In your protractor.conf.js add a reference to the hook listener (as shown above). In this example the file is found in 'support/'. Also make sure to set the output format to 'json'.
+
+```js
+cucumberOpts: {
+  require: ['steps/*.js', 'support/*.js'],
+  format: 'json'
+},
+```
 ### Options
 
-#### dest
+#### options.dest
 Type: `String`
 Default value: `'.'`
 
 The output directory for the HTML report relative from the Gulpfile
 
-#### filename
+#### options.filename
 Type: `String`
 Default value: `'report.html'`