README.md in checkr-official-1.0.0 vs README.md in checkr-official-1.0.1

- old
+ new

@@ -1,24 +1,32 @@ -# Checkr Ruby bindings ![Travis CI Status](https://travis-ci.org/checkr/checkr-ruby.svg?branch=master) +# Checkr Ruby bindings ![Travis CI Status](https://travis-ci.org/checkr/checkr-ruby.svg?branch=master) [![Code Climate](https://codeclimate.com/github/checkr/checkr-ruby/badges/gpa.svg)](https://codeclimate.com/github/checkr/checkr-ruby) ## Installation You don't need this source code unless you want to modify the gem. If you just want to use the Checkr Ruby bindings, you should run: ```bash -gem install checkr +gem install checkr-official ``` If you want to build the gem from source: ```bash -gem build checkr.gemspec +gem build checkr-official.gemspec ``` +If you want to include the gem in IRB you will need to require `checkr`. This naming will hopefully be cleared up if we are given ownership of the `checkr` gem on rubygems. + +```ruby +require 'checkr' +``` + + + ## Requirements * Ruby 1.8.7 or above. (Ruby 1.8.6 may work if you load ActiveSupport.) For Ruby versions before 1.9.2, you'll need to add this to your Gemfile: @@ -38,10 +46,10 @@ ```ruby source 'https://rubygems.org' gem 'rails' -gem 'checkr' +gem 'checkr-official' ``` ## Development