README.md in capybara-firebug-1.3.0 vs README.md in capybara-firebug-2.0.0
- old
+ new
@@ -1,29 +1,20 @@
capybara-firebug provides a dead-simple way to run Capybara-based Cucumber
scenarios or RSpec request specs with Firebug enabled under the selenium driver.
-1. Install the gem
-2. `require 'capybara/firebug'` in env.rb or spec_helper.rb
-3. Tag the tests you need to debug:
- - Tag Cucumber scenarios with `@firebug`
- - Tag RSpec examples with `:firebug => true`
-4. Run 'em
+To use it in RSpec examples, `require 'capybara/firebug/rspec'` in spec_helper.rb,
+and tag the examples you need to debug with `:firebug => true`.
-Firebug will be set up so that all features are fully enabled on every page.
+To use it in Cucumber scenarios, `require 'capybara/firebug/cucumber'` in env.rb,
+and tag the scenarios you need to debug with `@firebug`.
-You'll want to be able to pause the scenario at some point to inspect things
-in Firebug. A step definition for `Then stop and let me debug` is provided
-for this purpose. When executed, it breaks in the Ruby debugger. (If you are
-using bundler, you will also need to specify the correct debugging gem in your
-Gemfile: `gem 'ruby-debug'` for 1.8, `gem 'ruby-debug19'` for 1.9.)
-
## Firebug Versions
-By default, this gem uses Firebug 1.11.0, which is compatible with Firefox 17-20.
+By default, this gem uses Firebug 1.12.4, which is compatible with Firefox 23-25.
If you want to use Firebug 1.7.3 (compatible with Firefox 3.6, 4, and 5), 1.9.2
-(compatible with Firefox 6-13), or 1.10.6 (compatible with Firefox 13-18), you
+(compatible with Firefox 6-13), 1.10.6 (compatible with Firefox 13-18), or 1.11.0 (compatible with Firefox 17-22), you
need to explicitly specify the firebug_version setting in your `capybara.rb`
support file:
# located in features/support/capybara.rb or similar
require 'capybara/firebug'
@@ -41,5 +32,21 @@
Capybara::Driver::Selenium.new(app,
:browser => :remote,
:url => "http://my.ip.add.ress:4444/wd/hub",
:desired_capabilities => Selenium::WebDriver::Remote::Capabilities.firefox(:firefox_profile => profile))
+
+## Upgrading from 1.x
+
+Cucumber and RSpec support has been split into separate files. You'll need to change
+spec_helper.rb to `require 'capybara/firebug/rspec'` or env.rb to `require 'capybara/firebug/cucumber'`.
+
+A "stop and let me debug" step definition is no longer provided. You can add it
+yourself if needed:
+
+```
+Then /^stop and let me debug$/ do
+ debugger
+end
+```
+
+Ruby 1.8.x is no longer supported. Please upgrade to 2.0 or later.