From f415b06ba3aeacd0c5eb77e49a93e332a1b17564 Mon Sep 17 00:00:00 2001 From: Matt Robenolt Date: Sat, 17 May 2014 13:44:42 -0700 Subject: [PATCH] Add elevator pitch to README --- README.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 7d4b580..99d16af 100644 --- a/README.rst +++ b/README.rst @@ -7,7 +7,17 @@ django-sudo .. image:: https://coveralls.io/repos/mattrobenolt/django-sudo/badge.png?branch=master :target: https://coveralls.io/r/mattrobenolt/django-sudo?branch=master -Sudo mode is an extra layer of security for your most sensitive pages. +``django-sudo`` is an implementation of GitHub's `Sudo Mode +`_ for `Django +`_. + +What is this for? +~~~~~~~~~~~~~~~~~ +``django-sudo`` provides an extra layer of security for after a user is already logged in. Views can +be decorated with :func:`@sudo_required `, and then a user +must re-enter their password to view that page. After verifying their password, that user has +elevated permissions for the duration of ``SUDO_COOKIE_AGE``. This duration is independent of the +normal session duration allowing short elevated permission durations, but retain long user sessions. Installation ~~~~~~~~~~~~