README in cryx-cacheability-1.1.0 vs README in cryx-cacheability-1.2.1
- old
+ new
@@ -1,18 +1,21 @@
-Cacheability
-============
+= cacheability
+
A gem that makes client-side caching of HTTP requests a no-brainer. It is built upon the Rack:Cache gem from Ryan Tomayko.
Cached data can be stored in heap, file or memcached. See the Rack::Cache documentation (http://tomayko.com/src/rack-cache/) for more information.
-Installation
-============
- gem install cryx-cacheability
+= Installation
+
+ gem install cacheability
-Usage
-=====
+= Usage
+
require 'cacheability/restclient'
+
+ RestClient.log = 'stdout' # displays requests and status codes
+
resource = RestClient::CacheableResource.new( 'http://some/cacheable/resource',
:cache => { :metastore => 'file:/tmp/cache/meta',
:entitystore => 'file:/tmp/cache/body' }
)
resource.get # get from remote server, and cache if possible
@@ -25,17 +28,16 @@
Do yourself a favor and read:
* the HTTP specification related to HTTP caching - http://www.w3.org/Protocols/rfc2616/rfc2616-sec13.html
* Things Caches Do - http://tomayko.com/writings/things-caches-do
-Supported libraries
-===================
+= Supported libraries
+
* rest-client > 0.9
-Dependencies
-============
+= Dependencies
+
* rack-cache
-COPYRIGHT
-=========
+= COPYRIGHT
Copyright (c) 2008 Cyril Rohr. See LICENSE for details.
\ No newline at end of file