capybara-webkit/README.md

capybara-webkit
===============

A [capybara](https://github.com/jnicklas/capybara) driver that uses [WebKit](http://webkit.org) via [QtWebKit](http://doc.qt.nokia.com/4.7/qtwebkit.html).

Qt Dependency
-------------

capybara-webkit depends on a WebKit implementation from Qt, a cross-platform
development toolkit. You'll need to download the Qt libraries to build and
install the gem. You can find instructions for downloading and installing QT on
the [capybara-webkit wiki](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-QT)

CI
--

If you're like us, you'll be using capybara-webkit on CI.

On Linux platforms, capybara-webkit requires an X server to run, although it doesn't create any visible windows. Xvfb works fine for this. You can setup Xvfb yourself and set a DISPLAY variable, or try out the [headless gem](https://github.com/leonid-shevtsov/headless).

Usage
-----

Add the capybara-webkit gem to your Gemfile:

    gem "capybara-webkit"

Set your Capybara Javascript driver to webkit:

    Capybara.javascript_driver = :webkit

Tag scenarios with @javascript to run them using a headless WebKit browser.

Contributing
------------

See the CONTRIBUTING document.

About
-----

The capybara WebKit driver was written by Joe Ferris, Tristan Dunn, and Jason Morrison from [thoughtbot, inc](http://thoughtbot.com/community).

Code for rendering the current webpage to a PNG is borrowed from Phantom.js' implementation.

![thoughtbot](http://thoughtbot.com/images/tm/logo.png)

The names and logos for thoughtbot are trademarks of thoughtbot, inc.

Notes
-----

capybara-webkit will listen on port 8200. This may conflict with other services.

License
-------

capybara-webkit is Copyright (c) 2011 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.
Added README with a link to download Qt on OSX 2011-02-28 11:01:34 -05:00			`capybara-webkit`
			`===============`

Updated license ane readme 2011-03-09 17:55:40 -05:00			`A [capybara](https://github.com/jnicklas/capybara) driver that uses [WebKit](http://webkit.org) via [QtWebKit](http://doc.qt.nokia.com/4.7/qtwebkit.html).`
Added README with a link to download Qt on OSX 2011-02-28 11:01:34 -05:00
make it read better 2011-09-17 12:10:47 -03:00			`Qt Dependency`
Moved info about installing QT into the Wiki 2011-09-14 17:14:03 -04:00			`-------------`
Added README with a link to download Qt on OSX 2011-02-28 11:01:34 -05:00
Spruce up the README 2011-08-27 20:35:58 -04:00			`capybara-webkit depends on a WebKit implementation from Qt, a cross-platform`
			`development toolkit. You'll need to download the Qt libraries to build and`
Moved info about installing QT into the Wiki 2011-09-14 17:14:03 -04:00			`install the gem. You can find instructions for downloading and installing QT on`
			`the [capybara-webkit wiki](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-QT)`
Clarify installation notes 2011-04-13 14:55:54 -04:00
improving the install instructions 2011-06-05 17:49:16 -04:00			`CI`
			`--`

			`If you're like us, you'll be using capybara-webkit on CI.`
Clarify installation notes 2011-04-13 14:55:54 -04:00
Added more readme notes on Qt and Xvfb 2011-04-14 16:48:53 -04:00			`On Linux platforms, capybara-webkit requires an X server to run, although it doesn't create any visible windows. Xvfb works fine for this. You can setup Xvfb yourself and set a DISPLAY variable, or try out the [headless gem](https://github.com/leonid-shevtsov/headless).`
Added Ubunutu instructions to the README 2011-04-13 12:17:59 -04:00
Updated license ane readme 2011-03-09 17:55:40 -05:00			`Usage`
			`-----`

			`Add the capybara-webkit gem to your Gemfile:`

			`gem "capybara-webkit"`

			`Set your Capybara Javascript driver to webkit:`

			`Capybara.javascript_driver = :webkit`

			`Tag scenarios with @javascript to run them using a headless WebKit browser.`

a contributing guide 2011-07-22 16:59:13 -04:00			`Contributing`
			`------------`

			`See the CONTRIBUTING document.`

Updated license ane readme 2011-03-09 17:55:40 -05:00			`About`
			`-----`

			`The capybara WebKit driver was written by Joe Ferris, Tristan Dunn, and Jason Morrison from [thoughtbot, inc](http://thoughtbot.com/community).`

Documenting that some code was borrowed from Phantom.js 2011-07-03 09:39:47 -04:00			`Code for rendering the current webpage to a PNG is borrowed from Phantom.js' implementation.`

Added a note about X servers and the thoughtbot logo 2011-04-13 13:31:27 -04:00			`![thoughtbot](http://thoughtbot.com/images/tm/logo.png)`

Updated license ane readme 2011-03-09 17:55:40 -05:00			`The names and logos for thoughtbot are trademarks of thoughtbot, inc.`

Change Capybara-webkit to listen on poty 8200, simple patch removes collission with ElasticSearch. Also documents port number so as to give people a heads-up 2011-06-29 19:14:27 +02:00			`Notes`
			`-----`

Spruce up the README 2011-08-27 20:35:58 -04:00			`capybara-webkit will listen on port 8200. This may conflict with other services.`
Change Capybara-webkit to listen on poty 8200, simple patch removes collission with ElasticSearch. Also documents port number so as to give people a heads-up 2011-06-29 19:14:27 +02:00
Updated license ane readme 2011-03-09 17:55:40 -05:00			`License`
			`-------`

Spruce up the README 2011-08-27 20:35:58 -04:00			`capybara-webkit is Copyright (c) 2011 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.`