README.md in recurly-0.3.3 vs README.md in recurly-0.3.4

- old
+ new

@@ -1,36 +1,34 @@ Recurly Ruby Client =================== -The Recurly Ruby Client library is an open source library to interact with Recurly's subscription management from your Ruby on Rails website. The library interacts with Recurly's [REST API](http://support.recurly.com/faqs/api). +The Recurly Ruby Client library is an open source library to interact with Recurly's subscription management from your Ruby on Rails website. The library interacts with Recurly's [REST API](http://support.recurly.com/api/basics). Usage ----- Please see the [documentation](http://support.recurly.com/faqs/api/ruby-client) and -[support forums](http://support.recurly.com/discussions) for more information. +[support forums](http://support.recurly.com/discussions) for more information. The [API Documentation](http://docs.recurly.com/api/basics) has numerous examples demonstrating how to use the Recurly Ruby client library. Installation ------------ -This library can be installed as a gem or a plugin. Your choice. +**Stable Version:** -**Rails3 Stable Version:** - gem 'recurly' **Bleeding Edge Version:** gem 'recurly', :git => "http://github.com/recurly/recurly-client-ruby.git" Setup (Rails 3) -------------- -The Recurly Ruby Client requires a username and password to connect. We recommend creating a user just for your API. Please see the [Authentication](http://support.recurly.com/faqs/api/authentication) documentation for more information. +The Recurly Ruby Client requires an API user to connect. Please see the [Authentication](http://support.recurly.com/faqs/api/authentication) documentation for more information. If using Rails 3, the easiest way to get Recurly set up is to run `rake recurly:setup`. This will create a config/recurly.yml that has your recurly account authentication, and the Recurly rails initializer will pick it up on restart of your web app. Setup (Rails 2 and other frameworks) @@ -38,12 +36,14 @@ Alternatively, if not using Rails 3, just make sure to call a Recurly configure block somewhere in your applications initialization. Recurly.configure do |c| c.username = 'api@yourcompany.com' - c.password = 'super_secret_password' - c.site = 'https://my-recurly-site.recurly.com' + c.password = 'your_api_key' + c.private_key = 'your_private_key' + c.environment = :production # or :sandbox for test sites + c.subdomain = 'your-recurly-subdomain' end In Rails 2.x, this code should be in config/initializers/recurly.rb In Sinatra, it should be within a `configure` block. @@ -56,12 +56,14 @@ Recurly.configure_from_yaml("./config/recurly.yml") The Recurly Configuration YAML is in the format of: username: myrecurlyuser@domain.com - password: myrecurlypassword - site: https://myrecurlysite.recurly.com + password: your_api_key + private_key: your_private_key + environment: :production + subdomain: your_recurly_subdomain The same format could be applied in JSON instead of YAML using: Recurly.configure_from_json('path/to/file.json') Clearing test data (Rails3) @@ -79,10 +81,12 @@ Examples -------- +The [API Documentation](http://docs.recurly.com/api/basics) has numerous examples demonstrating how to use the Ruby client library. + All the functionality is demonstrated by the tests in the __spec__ directory. Running the Specs ------------------ @@ -122,6 +126,6 @@ This will run `recurly:clear_test_data` (using your spec/config/recurly.yml authentication info) to clear out the test data on the server and then delete the associated spec/vcr files so you can start from scratch. API Documentation ----------------- -Please see the [Recurly API](http://docs.recurly.com/api/basics) for more information. +Please see the [Recurly API](http://docs.recurly.com/api/basics) for more information and examples. \ No newline at end of file