Skip to content

Commit

Permalink
Docs. Dependency version bump.
Browse files Browse the repository at this point in the history
  • Loading branch information
asciidisco committed Aug 1, 2013
1 parent 847699b commit eaf3288
Show file tree
Hide file tree
Showing 4 changed files with 54 additions and 11 deletions.
7 changes: 6 additions & 1 deletion Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -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']
},
Expand Down
29 changes: 24 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
23 changes: 21 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/

Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit eaf3288

Please sign in to comment.