Permalink
Browse files

Updated readme a bit.

  • Loading branch information...
1 parent ecf979b commit 146ad9a5e3d23990a9b0ca5dec6679a00a451617 @ionelmc committed Nov 8, 2011
Showing with 31 additions and 2 deletions.
  1. +31 −2 README.rst
View
@@ -3,11 +3,27 @@
=============================
-Brief redis monitoring in django admin
+Redis monitoring drop-in application using django admin.
+
+Features
+========
+
+* Sever statistics in the admin changelist
+* Key summary in the inspect view
+* Value introspection with pagination for lists and sorted sets
+
Installation guide
==================
+Install from pypi, with pip::
+
+ pip install django-redisboard
+
+Or with setuptools::
+
+ easy_install django-redisboard
+
Add ``redisboard`` to ``INSTALLED_APPS``::
INSTALLED_APPS += ("redisboard", )
@@ -20,9 +36,22 @@ Or if you use south you can migrate this app::
manage.py migrate redisboard
-
Then you can add redis servers in the admin. You will see the stats in the changelist.
+Optional django settings
+========================
+
+REDISBOARD_DETAIL_FILTERS - a list of regular expressions to match against the keys in the server
+details colum. Eg, to only show uptime and list of active databases::
+
+ REDISBOARD_DETAIL_FILTERS = ['uptime.*', 'db.*']
+
+To show all the details just use::
+
+ REDISBOARD_DETAIL_FILTERS = ['.*']
+
+REDISBOARD_ITEMS_PER_PAGE - default 1000. Used for paginating the items from a list or a sorted set.
+
Screenshots
===========

0 comments on commit 146ad9a

Please sign in to comment.