Skip to content
Browse files

add links to "Things Caches Do" in doc; update README

  • Loading branch information...
1 parent 98782da commit 12c1765948a333a561323d4c666bdcf318a42823 @rtomayko rtomayko committed Nov 24, 2008
Showing with 8 additions and 7 deletions.
  1. +1 −5 README
  2. +6 −2 doc/index.markdown
  3. +1 −0 doc/layout.html.erb
View
6 README
@@ -3,11 +3,7 @@ Rack::Cache
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.
-
-We strive to implement those portions of RFC 2616 Section 13 relevant to gateway
-(i.e., "reverse proxy") cache scenarios with a system for specifying cache
-policy:
+validation (Last-Modified, ETag) information:
* Standards-based (RFC 2616)
* Freshness/expiration based caching
View
8 doc/index.markdown
@@ -47,8 +47,7 @@ simply `require` and `use` as follows:
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. More sophisticated stuff is possible with [Rack::Cache's Configuration
-Language][config].
+caching.
Advanced Usage
--------------
@@ -60,6 +59,9 @@ Advanced Usage
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
+ 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
@@ -70,6 +72,7 @@ Advanced Usage
get a feel for how the system has been put together; I recommend
[reading the source](http://github.com/rtomayko/rack-cache/master/lib/rack/cache).
+
See Also
--------
@@ -99,6 +102,7 @@ and is provided under [the MIT license](./license)
[config]: ./configuration "Rack::Cache Configuration Language Documentation"
[storage]: ./storage "Rack::Cache Storage Documentation"
+[things]: http://tomayko.com/writings/things-caches-do
[rfc]: http://tools.ietf.org/html/rfc2616
"RFC 2616 - Hypertext Transfer Protocol -- HTTP/1.1 [ietf.org]"
View
1 doc/layout.html.erb
@@ -14,6 +14,7 @@
<p>
<a href="./configuration" title='Configuration Language Documentation'>Config</a> |
<a href="./storage" title='Cache Storage Documentation'>Storage</a> |
+ <a href="http://tomayko.com/writings/things-caches-do" title="Things Caches Do">Things</a> |
<a href="./faq" title='Frequently Asked Questions'>FAQ</a> |
<a href="./api/" title='Fucking Sucks.'>RDoc</a>
</p>

0 comments on commit 12c1765

Please sign in to comment.
Something went wrong with that request. Please try again.