README.md in cloudflair-0.1.0 vs README.md in cloudflair-0.2.0

- old
+ new

@@ -21,10 +21,26 @@ Or install it yourself as: $ gem install cloudflair +## A Note on Faraday + +We have decided to not tightly control the version of faraday (anymore). The versions of faraday that are known to work are listed below. If you want to update to a newer version, you're doing it at your own risk. (But if it works, which is usually when all specs pass, please send a PR to update the list below.) + +To be on the safe side, we recommend to lock `faraday` to any of the versions listed below. This can be done like this: + +```ruby +gem 'cloudflair' +gem 'faraday', '>=0.13', '<0.14' +``` + +### Faraday Versions known to work + +* `gem 'faraday', '>= 0.12', '<= 0.13'` +* `gem 'faraday', '>= 0.13', '<= 0.14'` (starting with `gem 'cloudflair', '>= 0.2.0'`) + ## Usage ### Configuration Put this somewhere, where it runs, before any call to anything else of Cloudflair. @@ -155,10 +171,9 @@ ### Whishlist * Full API support * Metrics reporting * Rate Limit Tracking -* (Global/Distributed) Rate Limit Tracking ## License The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).