From 5d31ae91a4a5b06d639b8507f3bf7d4b20a16b97 Mon Sep 17 00:00:00 2001
From: asciidisco <public@asciidisco.com>
Date: Thu, 1 Aug 2013 18:26:51 +0200
Subject: [PATCH] Docs. Dependency version bump.

---
 Gruntfile.js |  7 ++++++-
 README.md    | 47 +++++++++++++++++++++++++++++++++++++++++------
 index.js     | 38 +++++++++++++++++++++++++++++++++++++-
 package.json |  6 +++---
 4 files changed, 87 insertions(+), 11 deletions(-)

diff --git a/Gruntfile.js b/Gruntfile.js
index 39b0bfe..6ddb672 100644
--- a/Gruntfile.js
+++ b/Gruntfile.js
@@ -98,7 +98,12 @@ module.exports = function (grunt) {
       options: {
         header: 'dalekjs/dalekjs.com/master/assets/header.html',
         footer: 'dalekjs/dalekjs.com/master/assets/footer.html',
-        target: 'report/docs'
+        target: 'report/docs',
+        vars: {
+          title: 'DalekJS - Documentation - Browser - Mozilla Firefox',
+          desc: 'DalekJS - Documentation - Browser - Mozilla Firefox',
+          docs: true
+        }
       },
       src: ['index.js']
     },
diff --git a/README.md b/README.md
index 484e9da..0d322cc 100644
--- a/README.md
+++ b/README.md
@@ -12,11 +12,7 @@ dalek-browser-firefox
 [![unstable](https://rawgithub.com/hughsk/stability-badges/master/dist/unstable.svg)](http://github.com/hughsk/stability-badges)
 
 [![NPM](https://nodei.co/npm/dalek-browser-firefox.png)](https://nodei.co/npm/dalek-browser-firefox/)
-
-## Warning
-
-This module is a browser plugin for [DalekJS](//github.com/dalekjs/dalek).
-It provides all a WebDriverServer & browser launcher for Firefox, used by DalekJS.
+[![NPM](https://nodei.co/npm-dl/dalek-browser-firefox.png)](https://nodei.co/npm/dalek-browser-firefox/)
 
 ## Ressources
 
@@ -29,6 +25,45 @@ It provides all a WebDriverServer & browser launcher for Firefox, used by DalekJ
 [Homepage](http://dalekjs.com) -
 [Twitter](http://twitter.com/dalekjs)
 
+## Docs
+
+This module is a browser plugin for [DalekJS](//github.com/dalekjs/dalek).
+It provides all a WebDriverServer & browser launcher for Mozilla Firefox.
+
+The browser plugin can be installed with the following command:
+
+```
+$ npm install dalek-browser-firefox --save-dev
+```
+
+You can use the browser plugin by adding a config option to the your Dalekfile
+
+```js
+"browsers": ["firefox"]
+```
+
+Or you can tell Dalek that it should test in this browser via the command line:
+
+```
+$ dalek mytest.js -b firefox
+```
+
+Because of the availability of the Firefox Marionette testing framework,
+Dalek atm. can only drive the Firefox Aurora Debug builds.
+
+You also have to add the location of the browser executable to you Dalekfile,
+because Dalek isn't capable of finding the executable yet on its own.
+
+```js
+  "browsers": [{
+    "firefox": {
+      "path": "~/Apps/FirefoxAuroraDebug.app/"
+    }
+  }]
+```
+
+The Firefox plugin only implements a subset of Daleks Assertions & Actions, so if you run into any bugs, the issue is most probably related to missing commands.
+
 ## Help Is Just A Click Away
 
 ### #dalekjs on FreeNode.net IRC
@@ -62,7 +97,7 @@ requests that implement the feature).
 other, better channels for seeking assistance, like StackOverflow and the
 Google Groups mailing list.
 
-![DalekJS](https://raw.github.com/dalekjs/dalekjs.com/master/img/logo.jpg)
+![DalekJS](https://raw.github.com/dalekjs/dalekjs.com/master/img/logo.png)
 
 ## Legal FooBar (MIT License)
 
diff --git a/index.js b/index.js
index 6464a56..6fad4a1 100644
--- a/index.js
+++ b/index.js
@@ -37,7 +37,43 @@ var Marionette = require('./lib/marionette');
 var WebDriverServer = require('./lib/webdriver');
 
 /**
- * FirefoxDriver base class
+ * This module is a browser plugin for [DalekJS](//github.com/dalekjs/dalek).
+ * It provides all a WebDriverServer & browser launcher for Mozilla Firefox.
+ *
+ * The browser plugin can be installed with the following command:
+ *
+ * ```bash
+ * $ npm install dalek-browser-firefox --save-dev
+ * ```
+ *
+ * You can use the browser plugin by adding a config option to the your Dalekfile
+ *
+ * ```javascript
+ * "browsers": ["firefox"]
+ * ```
+ *
+ * Or you can tell Dalek that it should test in this browser via the command line:
+ *
+ * ```bash
+ * $ dalek mytest.js -b firefox
+ * ```
+ *
+ * Because of the availability of the Firefox Marionette testing framework,
+ * Dalek atm. can only drive the Firefox Aurora Debug builds.
+ *
+ * You also have to add the location of the browser executable to you Dalekfile,
+ * because Dalek isn't capable of finding the executable yet on its own.
+ *
+ * ```javascript
+ * "browsers": [{
+ *   "firefox": {
+ *     "path": "~/Apps/FirefoxAuroraDebug.app/"
+ *   }
+ * }]
+ * ```
+ *
+ * The Firefox plugin only implements a subset of Daleks Assertions & Actions, so if you run into any bugs,
+ * the issue is most probably related to missing commands.
  *
  * @module DalekJS
  * @class FirefoxDriver
diff --git a/package.json b/package.json
index e95af76..68fae63 100644
--- a/package.json
+++ b/package.json
@@ -12,16 +12,16 @@
   "devDependencies": {
     "grunt": "~0.4.1",
     "grunt-contrib-clean": "~0.5.0",
-    "grunt-contrib-jshint": "~0.6.0",
+    "grunt-contrib-jshint": "~0.6.2",
     "grunt-contrib-yuidoc": "~0.4.0",
     "grunt-contrib-compress": "~0.5.2",
-    "grunt-mocha-test": "~0.6.1",
+    "grunt-mocha-test": "~0.6.2",
     "grunt-complexity": "~0.1.3",
     "grunt-plato": "~0.2.1",
     "grunt-documantix": "~0.0.3",
     "grunt-include-replace": "~1.1.0",
     "blanket": "~1.1.5",
-    "chai": "~1.7.0"
+    "chai": "~1.7.2"
   },
   "scripts": {
     "test": "grunt test"