From eaf328816418b83530282a4193035ecaf3ca3196 Mon Sep 17 00:00:00 2001 From: asciidisco Date: Thu, 1 Aug 2013 17:14:44 +0200 Subject: [PATCH] Docs. Dependency version bump. --- Gruntfile.js | 7 ++++++- README.md | 29 ++++++++++++++++++++++++----- index.js | 23 +++++++++++++++++++++-- package.json | 6 +++--- 4 files changed, 54 insertions(+), 11 deletions(-) diff --git a/Gruntfile.js b/Gruntfile.js index f18087a..d1a8b39 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 - Google Chrome', + desc: 'DalekJS - Documentation - Browser - Google Chrome', + docs: true + } }, src: ['index.js'] }, diff --git a/README.md b/README.md index 66dc3d5..57911cc 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,7 @@ dalek-browser-chrome [![unstable](https://rawgithub.com/hughsk/stability-badges/master/dist/unstable.svg)](http://github.com/hughsk/stability-badges) [![NPM](https://nodei.co/npm/dalek-browser-chrome.png)](https://nodei.co/npm/dalek-browser-chrome/) - -## Warning - -This module is a browser plugin for [DalekJS](https://github.com/dalekjs/dalek). -It provides all a WebDriverServer & browser launcher for chrome, used by DalekJS. +[![NPM](https://nodei.co/npm-dl/dalek-browser-chrome.png)](https://nodei.co/npm/dalek-browser-chrome/) ## Ressources @@ -29,6 +25,29 @@ It provides all a WebDriverServer & browser launcher for chrome, used by DalekJS [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 Google Chrome. + +The browser plugin can be installed with the following command: + +``` +$ npm install dalek-browser-chrome --save-dev +``` + +You can use the browser plugin by adding a config option to the your Dalekfile + +```js +"browsers": ["chrome"] +``` + +Or you can tell Dalek that it should test in this browser via the command line: + +``` +$ dalek mytest.js -b chrome +``` + ## Help Is Just A Click Away ### #dalekjs on FreeNode.net IRC diff --git a/index.js b/index.js index 959437b..c9db396 100644 --- a/index.js +++ b/index.js @@ -32,12 +32,31 @@ var spawn = require('child_process').spawn; var chromedriver = require('./lib/chromedriver'); /** - * Chrome Driver base class + * This module is a browser plugin for [DalekJS](//github.com/dalekjs/dalek). + * It provides all a WebDriverServer & browser launcher for Google Chrome. + * + * The browser plugin can be installed with the following command: + * + * ``` + * $ npm install dalek-browser-chrome --save-dev + * ``` + * + * You can use the browser plugin by adding a config option to the your Dalekfile + * + * ```js + * "browsers": ["chrome"] + * ``` + * + * Or you can tell Dalek that it should test in this browser via the command line: + * + * ``` + * $ dalek mytest.js -b chrome + * ``` * * @module DalekJS * @class ChromeDriver * @namespace Browser - * @part chrome + * @part Chrome * @api */ diff --git a/package.json b/package.json index b3492fc..ec8af8a 100644 --- a/package.json +++ b/package.json @@ -15,16 +15,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",