README.md in briar-1.1.0 vs README.md in briar-1.1.1
- old
+ new
@@ -1,28 +1,33 @@
-# Briar
+[](https://gemnasium.com/jmoody/briar)
+[](http://opensource.org/licenses/MIT)
+====
+
+## Briar
+
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
+### Briar is not trying to provide steps that will work for every project.
Every project should cultivate its own [vernacular](http://en.wikipedia.org/wiki/Vernacular) -
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
### 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 supporting code.
## Installation
-Requires ruby >= 1.8.7; ruby 2.0 is recommended.
+Requires ruby >= 1.9.3; ruby 2.1.2 is recommended.
In your Gemfile:
```
-gem 'briar'
+gem 'briar', '~>1.1'
```
In your `features/support/env.rb` file:
```
@@ -33,10 +38,11 @@
I18n.enforce_available_locales = false
```
To integrate briar and your calabash-ios console see: https://github.com/jmoody/briar/wiki/Integrating-Briar-Into-Your-Calabash-Console
+**WARNING:** I will be dropping the automatic import of pre-defined steps in briar 1.2.0. The predefined steps will be removed completely in briar 2.0.
## briar binary
The briar binary provides useful commands to improve your calabash workflow.
@@ -88,10 +94,18 @@
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 Semantic Versioning [1] when naming the versions.
+
+However, the semantic versioning spec is incompatible with RubyGem's patterns for pre-release gems. [2]
+
+_"But returning to the practical: No release version of SemVer is compatible with Rubygems."_ - David Kellum
+
+- [1] http://semver.org/
+- [2] http://gravitext.com/2012/07/22/versioning.html
+
## Why call it briar?
* http://en.wikipedia.org/wiki/Smoking_pipe_(tobacco)#Calabash
* http://en.wikipedia.org/wiki/Smoking_pipe_(tobacco)#Briar