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 ce7f068 commit 5d31ae9
Show file tree
Hide file tree
Showing 4 changed files with 87 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 - Mozilla Firefox',
desc: 'DalekJS - Documentation - Browser - Mozilla Firefox',
docs: true
}
},
src: ['index.js']
},
Expand Down
47 changes: 41 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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)

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

0 comments on commit 5d31ae9

Please sign in to comment.