README.md in restful_resource-1.6.0 vs README.md in restful_resource-2.0.1
- old
+ new
@@ -1,8 +1,30 @@
# RestfulResource ![build status](https://circleci.com/gh/carwow/restful_resource.svg?style=shield&circle-token=0558310359000e8786d1fe42774b0e30b2b0e12c)
Provides an ActiveResource like interface to JSON API's
+## Caching
+
+Caching using [faraday-http-cache](https://github.com/plataformatec/faraday-http-cache)
+
+Enabled by passing an initialsed cache object (eg Rails.cache)
+
+```
+RestfulResource::Base.configure(
+ base_url: "http://my.api.com/",
+ cache_store: Rails.cache
+)
+```
+
+### Bypassing the cache
+
+To make requests that bypass the local HTTP cache use the `no_cache: true` option eg:
+
+```
+Object.find(1, no_cache: true)
+```
+
+
## Metrics
### HTTP Metrics
Http requests are automatically instrumented using ActiveSupport::Notifications