= Sinatra::Cache

A Sinatra Extension that makes Page and Fragment Caching easy.

== IMPORTANT INFORMATION

This is a completely rewritten extension that basically breaks all previous versions of it.

So use with care! You have been warned ;-)

With that said, on to the real stuff.

== Installation

Add RubyGems.org (former Gemcutter) to your RubyGems sources

$ gem sources -a http://rubygems.org

$ (sudo)? gem install sinatra-cache

== Dependencies

This Gem depends upon the following:

=== Runtime:

• sinatra ( >= 1.0.a )
• sinatra-outputbuffer[http://github.com/kematzy/sinatra-outputbuffer] (>= 0.1.0)

Optionals:

• sinatra-settings[http://github.com/kematzy/sinatra-settings] (>= 0.1.1) # to view default settings in a browser display.

=== Development & Tests:

• sinatra-tests (>= 0.1.6)
• rspec (>= 1.3.0 )
• rack-test (>= 0.5.3)
• rspec_hpricot_matchers (>= 0.1.0)
• fileutils
• sass
• ostruct
• yaml
• json

== Getting Started

To start caching your app's ouput, just require and register the extension in your sub-classed Sinatra app:

require 'sinatra/cache'

class YourApp < Sinatra::Base

# NB! you need to set the root of the app first
set :root, '/path/2/the/root/of/your/app'

register(Sinatra::Cache)

set :cache_enabled, true  # turn it on

<snip...>

end

In your "classic" Sinatra app, you just require the extension and set some key settings, like this:

require 'rubygems' require 'sinatra' require 'sinatra/cache'

NB! you need to set the root of the app first

set :root, '/path/2/the/root/of/your/app' set :public, '/path/2/public'

set :cache_enabled, true # turn it on