diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ea13a15 --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2011 thoughtbot, inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md index d1673d4..239e477 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,37 @@ capybara-webkit =============== -A [capybara](https://github.com/jnicklas/capybara) driver that uses [WebKit](http://webkit.org) via [QtWebKit](https://trac.webkit.org/wiki/QtWebKit). +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). -Installation -------------- +Dependencies +------------ -You'll need to download Qt to build and install the gem. +capybara-webkit depends on a WebKit implementation from Qt, a cross-platform development toolkit. You'll need to download Qt to build and install the gem. + +* [Download Qt](http://qt.nokia.com/downloads/downloads) + +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. + +About +----- + +The capybara WebKit driver was written by Joe Ferris, Tristan Dunn, and Jason Morrison from [thoughtbot, inc](http://thoughtbot.com/community). + +The names and logos for thoughtbot are trademarks of thoughtbot, inc. + +License +------- + +capybara-webkit is Copyright © 2011 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file. -* [Download Qt for Mac OSX](http://qt.nokia.com/downloads/qt-for-open-source-cpp-development-on-mac-os-x/)