Browse files

Update README.rst

  • Loading branch information...
1 parent 2a2a6c5 commit 3ce789a9fd819d171b47ad610dfbdb4c1a7dda65 @d0ugal d0ugal committed Apr 20, 2012
Showing with 11 additions and 3 deletions.
  1. +11 −3 README.rst
View
14 README.rst
@@ -1,15 +1,23 @@
locache
------------------------------
-JavaScript caching framework for client side caching in the browser using
-localStorage. With a memcache inspired API usage is very easy and familiar.
-locache has no dependencies and is very small.
+JavaScript framework for client side caching in the browser using DOM
+Storage with expiring values. With a memcache inspired API usage is
+very simple. Locache has no dependencies and is very small.
locache gracefully degrades when the browser doesn't support localStorage.
Usually this will be IE6 or IE7, you wont get any errors, but caching
attempts will be silently dropped and lookups will always appear to be a
cache miss.
+When and why?
+~~~~~~~~~~~~~~~~~~~~
+Locache.js isn't a replacement for cache headers, and won't replace real
+server side caching. However, locache can be used to help speed up pages
+By caching results from APIs that you can't control or by caching complex
+structures created in JavaScript to avoid recreating. This works well with
+Models in backbone or rendered templates for example.
+
Setting, getting and removing values
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 comments on commit 3ce789a

Please sign in to comment.