README.md in recurly-2.4.5 vs README.md in recurly-2.4.6
- old
+ new
@@ -1,20 +1,20 @@
# Recurly [](http://travis-ci.org/recurly/recurly-client-ruby) [](http://badge.fury.io/rb/recurly)
<https://github.com/recurly/recurly-client-ruby>
-[Recurly](http://recurly.com/)'s Ruby client library is an interface to its
-[REST API](http://docs.recurly.com/api/basics).
+[Recurly](https://recurly.com/)'s Ruby client library is an interface to its
+[REST API](https://dev.recurly.com/docs/getting-started).
## Installation
Recurly is packaged as a Ruby gem. We recommend you install it with
[Bundler](http://gembundler.com/) by adding the following line to your Gemfile:
``` ruby
-gem 'recurly', '~> 2.4.5'
+gem 'recurly', '~> 2.4.6'
```
Recurly will automatically use [Nokogiri](http://nokogiri.org/) (for a nice
speed boost) if it's available and loaded in your app's environment.
@@ -36,26 +36,28 @@
```
Configure the client library with
[your API credentials](https://app.recurly.com/go/developer/api_access).
-* `RECURLY_SUBDOMAIN` should contain subdomain for your recurly account.
+* `RECURLY_SUBDOMAIN` should contain subdomain for your recurly account.
* `RECURLY_API_KEY` is your "Private API Key" which can be found under "API Credentials" on the `api_access` admin page.
The default currency is USD. To override with a different code:
``` ruby
Recurly.default_currency = 'EUR' # Assign nil to disable the default entirely.
```
-If you are using [Recurly.js](https://js.recurly.com) you can store "Public API Key" (which can be found under "API Credentials" on the `api_access` admin page):
+If you are using [Recurly.js](https://js.recurly.com) you can store "Public API Key" (which can be found
+under "API Credentials" on the `api_access` admin page):
``` ruby
Recurly.js.public_key = ENV['RECURLY_PUBLIC_API_KEY']
```
-Then, in your Rails project you can create `recurly_service.js.erb` file and [configure](https://docs.recurly.com/js/#configure) recurly.js with public key this way:
+Then, in your Rails project you can create `recurly_service.js.erb` file and
+[configure](https://docs.recurly.com/js/#configure) recurly.js with public key this way:
``` js
recurly.configure({ publicKey: '<%= Recurly.js.public_key %>'});
```
@@ -68,29 +70,31 @@
:ca_path => "/etc/ssl/certs"
}
```
## Multi-Threaded Configuration
-If you are using the client in a multi-threaded environment and require a different configuration per thread you can use the following within the thread's context:
+If you are using the client in a multi-threaded environment and require a different configuration per
+thread you can use the following within the thread's context:
``` ruby
Recurly.config({
subdomain: ENV['RECURLY_SUBDOMAIN']
api_key: ENV['RECURLY_API_KEY'],
default_currency: "US",
private_key: ENV['RECURLY_PUBLIC_API_KEY']
})
```
-Any configuration items you do not include in the above config call will be defaulted to the standard configuration items. For example if you do not define default_currency then
-Recurly.default_currency will be used.
+Any configuration items you do not include in the above config call will be defaulted to the standard
+configuration items. For example if you do not define default_currency then Recurly.default_currency
+will be used.
## Usage
Instructions and examples are available on
-[Recurly's documentation site](http://docs.recurly.com/api/basics).
+[Recurly's documentation site](https://dev.recurly.com/docs/getting-started).
Recurly's gem API is available
[here](http://rubydoc.info/gems/recurly/frames/Recurly).
## Support
@@ -105,13 +109,12 @@
## Contributing
Developing for the Recurly gem is easy with [Bundler](http://gembundler.com/).
-Fork and clone the repository, `cd` into the directory, and, with a Ruby of
-your choice (1.9.3 or greater), set up your
-environment.
+Fork and clone the repository, `cd` into the directory, and, with a Ruby of your choice
+(1.9.3 or greater), set up your environment.
If you don't have Bundler installed, install it with the following command:
``` bash
$ [sudo] gem install bundler
@@ -136,11 +139,10 @@
```
If you plan on submitting a patch, please write tests for it (we use
[MiniTest::Spec](http://bfts.rubyforge.org/minitest/MiniTest/Expectations.html)).
-If everything looks good, submit a pull request on GitHub and we'll bring in
-your changes.
+If everything looks good, submit a pull request on GitHub and we'll bring in your changes.
## License
(The MIT License.)