README.md in prickle-0.0.1 vs README.md in prickle-0.0.2
- old
+ new
@@ -6,65 +6,75 @@
```ruby
gem install prickle
```
-and to configure
+and to configure update your *features/support/env.rb* to include the following:
```ruby
-require 'prickle/capybara'
+require 'prickle/capybara' # require
+
World do
- include Capybara::DSL
- include Prickle::Capybara #include it after Capybara
+ include Capybara::DSL
+ include Prickle::Capybara # include Prickle
end
```
+## Waiting for elements to become visible
+
+To enable this feature you need to set the *Prickle::Capybara.wait_time* property.
+
+```ruby
+Prickle::Capybara.wait_time = 5
+```
+
+If you only want to extend the wait time for a particular feature, then you need to reset the wait time using *Prickle::Capybara = nil*.
+
## Usage
### Find elements by any html tag(s)
```ruby
- element(:href => "http://google.com")
- element(:name => "blue")
- element(:id => "key")
- element(:class => "key", :id => "button")
+element(:href => "http://google.com")
+element(:name => "blue")
+element(:id => "key")
+element(:class => "key", :id => "button")
```
### Find elements by type and html tag(s)
```ruby
- element(:link,:href => "http://google.com")
- element(:input, :name => "blue")
-``
+element(:link, :href => "http://google.com") # you can also use link and paragraph (instead of a and p)
+element(:input, :name => "blue")
+```
### Apply a search, a click or a text matcher
-``ruby
+```ruby
-element(:name => "flower")*.exists?*
-element(:name => "flower")*.click*
-element(:name => "flower")*.contains_text? "Roses"*
+element(:name => "flower").exists?
+element(:name => "flower").click
+element(:name => "flower").contains_text? "Roses"
```
## Alternative syntax
### Find
```ruby
- find_by_name "green"
-
- find_button_by_name "green" #find_<element_tag>_by_name "<name>"
+find_by_name "green"
+find_button_by_name "green" #find_<element_tag>_by_name "<name>"
```
-## Click
+### Click
```ruby
- click_by_name "blue"
- click_input_by_name "blue" #click_<element_tag>_by_name "<name>"
-``
+click_by_name "blue"
+click_input_by_name "blue" #click_<element_tag>_by_name "<name>"
+```
### Match text
```ruby
- div_contains_text? "text" #<element_tag>_contains_text? "text"
+div_contains_text? "text" #<element_tag>_contains_text? "text"
```