Skip to content

Commit

Permalink
Add more words about caching in the docs quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
benjaoming authored Nov 3, 2019
1 parent b043bfe commit fc542f4
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Django Ratelimit
Project
=======

**Django Ratelimit** is a ratelimiting decorator for Django views.
**Django Ratelimit** is a ratelimiting decorator for Django views, storing rate data in the configured `Django cache backend <https://docs.djangoproject.com/en/dev/topics/cache/>`__.

.. image:: https://travis-ci.org/jsocol/django-ratelimit.png?branch=master
:target: https://travis-ci.org/jsocol/django-ratelimit
Expand Down Expand Up @@ -40,6 +40,7 @@ Use as a decorator in ``views.py``:
def secondview(request):
# ...
After activating django-ratelimit, you should ensure that your cache backend is setup to be both persistent and work across multiple deployment worker instances (for instance UWSGI workers). Read more in the Django docs on `caching <https://docs.djangoproject.com/en/dev/topics/cache/>`__.

.. _PyPI: http://pypi.python.org/pypi/django-ratelimit

Expand Down

0 comments on commit fc542f4

Please sign in to comment.