README.md in crp-0.0.1 vs README.md in crp-0.0.2

- old
+ new

@@ -2,11 +2,11 @@ The **C**entral **R**eview **P**latform is a platform to review user uploaded data. This gem wraps the CRP API in a more Ruby like syntax. ## Installation -The CRP gem is Ruby 1.9.x and 2.0.x compatible. +The CRP gem is Ruby 1.9.x and 2.0.x compatible and hosted on [RubyGems](https://rubygems.org/gems/crp). Add this line to your application's Gemfile: gem 'crp' @@ -25,17 +25,17 @@ ```` ruby require "crp" => true review_poster = CRP::ReviewPoster.new("crp.example.com", "client", "key") => #<CRP::ReviewPoster:0x007fa2c1119110 @host="crp.example.com", @client="client", @key="key"> -review_response = review_poster.new_review(1, "davy22", 123, 2, "davy22", 55) +review_response = review_poster.new_review(1, "davy22", "123ABC", :female, "davy22", 55) => #<CRP::ReviewResponse:0x007fa87c1fd020 @response=#<Net::HTTPOK 200 OK readbody=true>> review_response.successful? => true review_response.internal_id - => 123 + => "123ABC" review_response.external_id - => "4321" + => "ABCD1234" ```` You can skip the host, client and key parameters and specify the `ENV['CRP_HOST']`, `ENV['CRP_CLIENT']` and `ENV['CRP_KEY']` environment variable for convenience. Parse the callback received from CRP: