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)

Reporting Issues
----------------

Without access to your application code we can't easily debug most crashes or
generic failures, so we've included a debug version of the driver that prints a
log of what happened during each test. Before filing a crash bug, please see
[Reporting Crashes](https://github.com/thoughtbot/capybara-webkit/wiki/Reporting-Crashes).
You're much more likely to get a fix if you follow those instructions.

If you are having compiling issues please post to the [mailing list](http://groups.google.com/group/capybara-webkit).

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

In cucumber, tag scenarios with @javascript to run them using a headless WebKit browser.

In RSpec, use the :js => true flag.

Take note of the transactional fixtures section of the [capybara README](https://github.com/jnicklas/capybara/blob/master/README.rdoc).

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

See the CONTRIBUTING document.

About
-----

The capybara WebKit driver is maintained by Joe Ferris and Matt Mongeau. It was written by [thoughtbot, inc](http://thoughtbot.com/community) with the help of numerous [contributions from the open source community](https://github.com/thoughtbot/capybara-webkit/contributors).

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 16:01:34 +00:00			`capybara-webkit`
			`===============`

Updated license ane readme 2011-03-09 22:55:40 +00: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 16:01:34 +00:00
make it read better 2011-09-17 15:10:47 +00:00			`Qt Dependency`
Moved info about installing QT into the Wiki 2011-09-14 21:14:03 +00:00			`-------------`
Added README with a link to download Qt on OSX 2011-02-28 16:01:34 +00:00
Spruce up the README 2011-08-28 00:35:58 +00: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 21:14:03 +00: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 18:55:54 +00:00
Added a note about crashes to the README 2011-10-01 17:03:07 +00:00			`Reporting Issues`
			`----------------`

			`Without access to your application code we can't easily debug most crashes or`
Fix typo 2011-10-06 22:56:20 +00:00			`generic failures, so we've included a debug version of the driver that prints a`
Added a note about crashes to the README 2011-10-01 17:03:07 +00:00			`log of what happened during each test. Before filing a crash bug, please see`
			`[Reporting Crashes](https://github.com/thoughtbot/capybara-webkit/wiki/Reporting-Crashes).`
			`You're much more likely to get a fix if you follow those instructions.`

Added note about mailing list for compilation errors. 2012-01-13 16:44:20 +00:00			`If you are having compiling issues please post to the [mailing list](http://groups.google.com/group/capybara-webkit).`

improving the install instructions 2011-06-05 21:49:16 +00:00			`CI`
			`--`

			`If you're like us, you'll be using capybara-webkit on CI.`
Clarify installation notes 2011-04-13 18:55:54 +00:00
Added more readme notes on Qt and Xvfb 2011-04-14 20:48:53 +00: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 16:17:59 +00:00
Updated license ane readme 2011-03-09 22:55:40 +00:00			`Usage`
			`-----`

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

			`gem "capybara-webkit"`

			`Set your Capybara Javascript driver to webkit:`

			`Capybara.javascript_driver = :webkit`

Clean up README 2011-11-01 19:36:24 +00:00			`In cucumber, tag scenarios with @javascript to run them using a headless WebKit browser.`
Updated license ane readme 2011-03-09 22:55:40 +00:00
Clean up README 2011-11-01 19:36:24 +00:00			`In RSpec, use the :js => true flag.`

			`Take note of the transactional fixtures section of the [capybara README](https://github.com/jnicklas/capybara/blob/master/README.rdoc).`
Add a couple of notes that :js => true should still be used, and to note the Transactional fixtures gotcha in the main README 2011-11-01 19:19:28 +00:00
a contributing guide 2011-07-22 20:59:13 +00:00			`Contributing`
			`------------`

			`See the CONTRIBUTING document.`

Updated license ane readme 2011-03-09 22:55:40 +00:00			`About`
			`-----`

Update authors 2011-11-01 21:00:28 +00:00			`The capybara WebKit driver is maintained by Joe Ferris and Matt Mongeau. It was written by [thoughtbot, inc](http://thoughtbot.com/community) with the help of numerous [contributions from the open source community](https://github.com/thoughtbot/capybara-webkit/contributors).`
Updated license ane readme 2011-03-09 22:55:40 +00:00
Documenting that some code was borrowed from Phantom.js 2011-07-03 13:39:47 +00: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 17:31:27 +00:00			`![thoughtbot](http://thoughtbot.com/images/tm/logo.png)`

Updated license ane readme 2011-03-09 22:55:40 +00: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 17:14:27 +00:00			`Notes`
			`-----`

Spruce up the README 2011-08-28 00:35:58 +00: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 17:14:27 +00:00
Updated license ane readme 2011-03-09 22:55:40 +00:00			`License`
			`-------`

Spruce up the README 2011-08-28 00:35:58 +00: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.`