Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update README with install/config/usage

  • Loading branch information...
commit 63f570ff706178dba3ef2736d7c119c09d02d2c2 1 parent dd75086
@dcramer authored
Showing with 23 additions and 1 deletion.
  1. +23 −1 README.rst
View
24 README.rst
@@ -1,4 +1,26 @@
nexus-memcache
--------------
-Provides a memcache statistics module in `Nexus <https://github.com/dcramer/nexus>`_.
+Provides a memcache statistics module in `Nexus <https://github.com/dcramer/nexus>`_.
+
+Install
+=======
+
+Install using pip, or easy_install::
+
+ pip install nexus_memcache
+
+Config
+======
+
+Add nexus_memcache to your ``INSTALLED_APPS``::
+
+ INSTALLED_APPS = (
+ 'nexus',
+ 'nexus_memcache',
+ )
+
+Usage
+=====
+
+The memcache module is automatically integrated into Nexus and detects memcache using your ``CACHE_BACKEND`` setting.
Please sign in to comment.
Something went wrong with that request. Please try again.