Commits

EGh5 committed de1d3ef

text formatting

  • Participants
  • Parent commits d1e106c

Comments (0)

Files changed (1)

File doorkeeper/README.rst

-django-doorkeeper
-*****************
+Django Doorkeeper
+=================
 
+Features
+--------
 This application bannes bad bots making requests for exactly non-existent urls.
 Middleware-level is using.
 
-You should add patterns of this urls as LAST tuple elements in your urls.py
+Installation
+------------
+
+You should add patterns of this urls as LAST tuple elements in your urls.py::
 
   from doorkeeper.views import inspect
   ...    
     url(r'dba',inspect),
     )
 
-You can add this constants in your settings.py
+You can add this constants in your settings.py::
 
   DOORKEEPER_PATIENCE=3  # number of bad attempts
   DOORKEEPER_TERM=1200   # penalty time (sec.)
 
-Add to INSTALLED_APPS,
+Add to INSTALLED_APPS,::
+
   'doorkeeper', 
-and to MIDDLEWARE_CLASSES (as high as possible)
+
+and to MIDDLEWARE_CLASSES (as high as possible)::
+
   'doorkeeper.middleware.DoorkeeperMiddleware',
  
-    
+
+Monitoring
+------------
+
 You can watch your catch in django-admin.
  
 NOTE: this application is not intendent for high-loaded django-site. 
 
 
 Good luck in hunting!
+
 Eugene
 
-eug033@gmail.com
+.. _Bitbucket repository: https://bitbucket.org/EGh5/django-doorkeeper