README.md in briar-0.1.3.b5 vs README.md in briar-0.1.3.b6
- old
+ new
@@ -1,44 +1,60 @@
# Briar
-extends the steps defined in [calabash-ios](https://github.com/calabash/calabash-ios.git) to help
-your write cucumber Scenarios that interact with complex ui elements like tables, pickers, and sliders.
+Briar Extends the steps defined in [calabash-ios](https://github.com/calabash/calabash-ios.git) to help you write cucumber Scenarios that interact with complex UI elements like tables, pickers, and sliders.
### WARNING: briar is not trying to provide steps that will work for every project
Every project should cultivate its own [venacular](http://en.wikipedia.org/wiki/Vernacular) -
-a shared language between developers, clients, and users. the steps that briar provides
-are not meant to be dropped into into your projects (although they can be). briar provides a
-library [lib] of ruby methods to build application-specific steps from. the steps in the features
-directory are meant to be examples of what briar can offer.
+a shared language between developers, clients, and users. The [steps that briar provides](features/step_definitions) are not meant to be dropped into into your projects (although they can be). Briar provides a library of ruby methods to build application-specific steps from. The steps in the features directory are meant to be examples of what briar can offer.
-to see briar in action, take a look at https://github.com/jmoody/briar-ios-example
+To see briar in action, take a look at https://github.com/jmoody/briar-ios-example
### motivation
-DRY: i have several ios projects that use calabash-cucumber and i found i was rewriting lots of steps
-and supporting code.
+DRY: I have several iOS projects that use calabash-cucumber and I found I was rewriting lots of steps and supporting code.
+## Installation
+
+Requires ruby >= 1.9.2
+
+In your Gemfile:
+
+```
+gem 'briar'
+```
+
+In your `features/support/env.rb` file:
+
+```
+require 'calabash-cucumber/cucumber'
+require 'briar/cucumber'
+
+# optional
+I18n.enforce_available_locales = false
+```
+
+## Xamarin Test Cloud
+
+There is currently an issue with using briar predefined steps on the XTC:
+
+```
+# fails validation step
+Then I touch the "time" row
+```
+
## version numbers
-i will try my best to follow http://semver.org/ when naming the versions.
+I will try my best to follow http://semver.org/ when naming the versions.
## Why call it briar?
* http://en.wikipedia.org/wiki/Smoking_pipe_(tobacco)#Calabash
* http://en.wikipedia.org/wiki/Smoking_pipe_(tobacco)#Briar
-## Installation
+## Road Map
-getting closer to stability
-
-* there are still major problems with date picking
-* can now run tests on lesspainful! woot!
-* there are lot's of wait_for_animation calls that should be replaced with wait_for methods
-
-## Usage
-
-TODO: Write usage instructions here
+I am thinking of dropping all the of predefined steps! Beware! You have been warned!
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)