Skip to content

Commit

Permalink
doc and gemspec updates for 0.3.0
Browse files Browse the repository at this point in the history
  • Loading branch information
rtomayko committed Dec 28, 2008
1 parent dcc66ab commit 12bd534
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 16 deletions.
17 changes: 13 additions & 4 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@ validation (Last-Modified, ETag) information:

* Standards-based (RFC 2616)
* Freshness/expiration based caching
* Validation
* Validation (If-Modified-Since / If-None-Match)
* Vary support
* Cache-Control: public, private, max-age, s-maxage, must-revalidate,
and proxy-revalidate.
* Portable: 100% Ruby / works with any Rack-enabled framework
* Configuration language for advanced caching policies
* Disk, memcached, and heap memory storage backends
Expand Down Expand Up @@ -64,10 +66,17 @@ Assuming you've designed your backend application to take advantage of HTTP's
caching features, no further code or configuration is required for basic
caching.

Documentation
-------------
Links
-----

http://tomayko.com/src/rack-cache/
Documentation:
http://tomayko.com/src/rack-cache/

Mailing List:
http://groups.google.com/group/rack-cache

GitHub:
http://github.com/rtomayko/rack-cache/

License
-------
Expand Down
23 changes: 13 additions & 10 deletions doc/index.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ __Rack::Cache__ is suitable as a quick drop-in component to enable HTTP caching
for [Rack][]-based applications that produce freshness (`Expires`,
`Cache-Control`) and/or validation (`Last-Modified`, `ETag`) information.

* Standards-based ([RFC 2616][rfc] / [Section 13][s13]).
* Standards-based (see [RFC 2616][rfc] / [Section 13][s13]).
* Freshness/expiration based caching
* Validation
* Vary Support
* Vary support
* Portable: 100% Ruby / works with any [Rack][]-enabled framework.
* [Configuration language][config] for advanced caching policies.
* Disk, memcached, and heap memory [storage backends][storage].
Expand Down Expand Up @@ -49,24 +49,27 @@ Assuming you've designed your backend application to take advantage of HTTP's
caching features, no further code or configuration is required for basic
caching.

Advanced Usage
--------------
More
----

* [Configuration Language Documentation][config] - How to customize cache
* [Configuration Language Documentation][config] - how to customize cache
policy using the simple event-based configuration system.

* [Cache Storage Documentation][storage] - Detailed information on the various
* [Cache Storage Documentation][storage] - detailed information on the various
storage implementations available in __Rack::Cache__ and how to choose the one
that's best for your application.

* [Things Caches Do][things] - An illustrated guide to how HTTP gateway
* [Things Caches Do][things] - an illustrated guide to how HTTP gateway
caches work with pointers to other useful resources on HTTP caching.

* [FAQ](./faq) - Frequently Asked Questions about __Rack::Cache__.

* [GitHub Repository](http://github.com/rtomayko/rack-cache/) - Get your
* [GitHub Repository](http://github.com/rtomayko/rack-cache/) - get your
fork on.

* [Mailing List](http://groups.google.com/group/rack-cache) - for hackers
and users (`rack-cache@groups.google.com`).

* [FAQ](./faq) - Frequently Asked Questions about __Rack::Cache__.

* [RDoc API Documentation](./api/) - Mostly worthless if you just want to use
__Rack::Cache__ in your application but mildly insightful if you'd like to
get a feel for how the system has been put together; I recommend
Expand Down
5 changes: 3 additions & 2 deletions rack-cache.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Gem::Specification.new do |s|
s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=

s.name = 'rack-cache'
s.version = '0.2.0'
s.date = '2008-10-24'
s.version = '0.3.0'
s.date = '2008-12-28'

s.description = "HTTP Caching for Rack"
s.summary = "HTTP Caching for Rack"
Expand All @@ -26,6 +26,7 @@ Gem::Specification.new do |s|
doc/layout.html.erb
doc/license.markdown
doc/rack-cache.css
doc/server.ru
doc/storage.markdown
lib/rack/cache.rb
lib/rack/cache/config.rb
Expand Down

0 comments on commit 12bd534

Please sign in to comment.