README.md in namely-0.2.3 vs README.md in namely-0.2.4
- old
+ new
@@ -39,10 +39,26 @@
Namely associates a subdomain with your organization. For example, if
your account is at `http://your-organization.namely.com/`, your
subdomain would be `"your-organization"`.
+## Configuration
+
+You can override default configuration using `Namely.configuration` like:
+
+```Ruby
+Namely.configuration do |config|
+
+ # While returning paged results, which http codes should be rescued and
+ # retried? Defaults to none.
+ config.http_codes_to_retry = [504] # gateway timeout
+
+ # The number of times to retry the requests rescued above. Default is 0
+ config.retries = 2
+end
+```
+
## Usage Examples
Once you've created a connection you can use it to access your data.
```ruby
@@ -116,10 +132,10 @@
to include tests!
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new pull request. We'll review it and leave feedback for
you ASAP.
-[Namely's HTTP API]: http://namely.readme.io/v1/docs
+[Namely's HTTP API]: https://developers.namely.com
[thoughtbot's style guide]: https://github.com/thoughtbot/guides/tree/master/style
[JSON API standard]: http://jsonapi.org/
[dotenv]: https://github.com/bkeepers/dotenv
[Fork it!]: https://github.com/namely/ruby-client/fork