Basic readme updates to the versions now used

README.md

@@ -1,22 +1,38 @@
-Build Status: [![Build Status](https://travis-ci.org/ministryofjustice/govuk_elements_form_builder.svg)](https://travis-ci.org/ministryofjustice/govuk_elements_form_builder)
+Build Status: 
+[![Build Status](https://travis-ci.org/ministryofjustice/govuk_elements_form_builder.svg)](https://travis-ci.org/ministryofjustice/govuk_elements_form_builder)
 
 Code Climate: <a href="https://codeclimate.com/github/ministryofjustice/govuk_elements_form_builder"><img src="https://codeclimate.com/github/ministryofjustice/govuk_elements_form_builder/badges/gpa.svg" /></a> <a href="https://codeclimate.com/github/ministryofjustice/govuk_elements_form_builder/coverage"><img src="https://codeclimate.com/github/ministryofjustice/govuk_elements_form_builder/badges/coverage.svg" /></a>
+
 # GovukElementsFormBuilder
 
-To build GOV.UK based services you need to use [govuk_elements](https://github.com/alphagov/govuk_elements) for presentation and [govuk_frontend_toolkit](https://github.com/alphagov/govuk_frontend_toolkit) for the interaction aspects.
+To build GOV.UK based services you need to use 
+[govuk_elements](https://github.com/alphagov/govuk_elements) for presentation 
+and [govuk_frontend_toolkit](https://github.com/alphagov/govuk_frontend_toolkit) 
+for the interaction aspects.
 
-This gem serves a form builder and other various helper methods to produces the markup required to leverage presentation and interaction without having to recreate the markup yourself.
+This gem serves a form builder and other various helper methods to produces the 
+markup required to leverage presentation and interaction without having to 
+recreate the markup yourself.
 
 ## Installation
 
 Add these lines to your application's Gemfile, form builder is the last gem in list:
 
+Version 0
+
 ```ruby
-gem 'govuk_frontend_toolkit'
-gem 'govuk_elements_rails'
-gem 'govuk_elements_form_builder', git: 'https://github.com/ministryofjustice/govuk_elements_form_builder.git'
+gem 'govuk_frontend_toolkit', '~> 6.0.0'
+gem 'govuk_elements_rails', '~> 3.0.0'
+gem 'govuk_elements_form_builder', '~>0.0.0'
 ```
 
+Version 1+
+```ruby
+gem 'govuk_frontend_toolkit', '~> 6.0.0'
+gem 'govuk_elements_rails', '~> 3.0.0'
+gem 'govuk_elements_form_builder',  '~>1.0.0'
+```
+
 And then execute:
 
 ```sh
@@ -25,7 +41,8 @@ bundle
 
 ## Usage
 
-In your application's `config/application.rb` file, configure the form builder to be the default like this:
+In your application's `config/application.rb` file, configure the form builder 
+to be the default like this:
 
 ```rb
   class Application < Rails::Application
@@ -34,20 +51,53 @@ In your application's `config/application.rb` file, configure the form builder t
   end
 ```
 
-You can see a visual guide to [using the form builder](https://govuk-elements-rails-guide.herokuapp.com/) here:
-https://govuk-elements-rails-guide.herokuapp.com/
+You can see a visual guide to 
+[using the form builder](https://govuk-elements-rails-guide.herokuapp.com/) 
+here: https://govuk-elements-rails-guide.herokuapp.com/
+
+
+## Versions - Which version should you used?
+
+We encourage developers to use the latest version but understand that sometimes
+it is not possible to do so. Seeing as there was quite a significant change
+to the markup needed with the release of GOVUK Elements 3.0. We have decided to 
+create two supporting versions of the form builder for those services that use 
+the older GOVUK Elements and Frontend toolkit or who would like to use the 
+latest GOVUK assets.
+
+Since version 1, GOVUK Elements and Frontend versions have now become a dependency
+to help ensure that developers use the correct GOVUK Form builder version.
+
+ For the time being the only differences between the two versions is the markup
+  that this gem produces. We will try and keep the methods identical between versions 
+  but if you decide to upgrade to version 1 you should check any pages that use 
+  Radio buttons or Checkboxes and any js/css that rely on the markup these two
+  elements use. Another thing you should check is if you rely on the
+  css class name used for errors as this has also been renamed.
 
 ## Development
 
-After checking out the repo, run `bundle install` to install dependencies. Then, run `bundle exec rspec` to run the tests.
+After checking out the repo, run `bundle install` to install dependencies. 
+Then, run `bundle exec rspec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. 
+To release a new version, update the version number in `version.rb`, and then 
+run `bundle exec rake release`, which will create a git tag for the version, 
+push git commits and tags, and push the `.gem` file to 
+[rubygems.org](https://rubygems.org).
+
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/govuk_elements_form_builder. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at 
+https://github.com/[USERNAME]/govuk_elements_form_builder. This project is 
+intended to be a safe, welcoming space for collaboration, and contributors are 
+expected to adhere to the [Contributor Covenant](contributor-covenant.org) 
+code of conduct.
 
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of 
+the [MIT License](http://opensource.org/licenses/MIT).