django-cache-utils / README.rst

Diff from to

README.rst

 
 django-cache-utils provides some utils for make cache-related work easier:
 
-* ``cached`` decorator. It can be applied to function, method or classmethod.
+* ``cached`` decorator. It can be applied to function, method or classmethod
+  and can be used with any django cache backend (built-in or third-party like
+  django-newcache).
 
-  Supports bulk cache invalidation and fine-grained invalidation for
-  exact parameter set. Cache keys are human-readable because they are
-  constructed from callable's full name and arguments and then sanitized
-  to make memcached happy.
+  Supports fine-grained invalidation for exact parameter set (with any backend)
+  and bulk cache invalidation (only with ``group_backend``). Cache keys are
+  human-readable because they are constructed from callable's full name and
+  arguments and then sanitized to make memcached happy.
 
-  Wrapped callable gets `invalidate` methods. Call `invalidate` with
+  Wrapped callable gets ``invalidate`` methods. Call ``invalidate`` with
   same arguments as function and the cached result for these arguments will be
   invalidated.
 
-* django memcached cache backend with group O(1) invalidation ability,
-  dog-pile effect prevention using MintCache algorythm
+* ``group_backend``. It is a django memcached cache backend with group O(1)
+  invalidation ability, dog-pile effect prevention using MintCache algorythm
   and project version support to allow gracefull updates and multiple django
   projects on same memcached instance.
   Long keys (>250) are auto-truncated and appended with md5 hash.
 Usage
 =====
 
-Without ``group_backend``::
+`cached` decorator can be used with any django caching backend (built-in or
+third-party like django-newcache)::
 
     from cache_utils.decorators import cached
 
     obj.foo(1,2)
 
 
-With ``group_backend``::
+With ``group_backend`` `cached` decorator supports bulk O(1) invalidation::
 
     from django.db import models
     from cache_utils.decorators import cached
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.