summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorOlivier Larchevêque <olivier.larcheveque@auf.org>2013-08-13 18:16:35 (GMT)
committerOlivier Larchevêque <olivier.larcheveque@auf.org>2013-08-13 18:16:35 (GMT)
commit0144aa7f3b0961029d25a26f5632537decc6756a (patch)
treefdaf8765d6c67ada4838d327447897f74290bade /README
parent430780d94bfaf895e85ca62738cb3b60c5b3ce2e (diff)
downloadauf-django-secretquestions-0144aa7f3b0961029d25a26f5632537decc6756a.zip
auf-django-secretquestions-0144aa7f3b0961029d25a26f5632537decc6756a.tar.gz
auf-django-secretquestions-0144aa7f3b0961029d25a26f5632537decc6756a.tar.bz2
readme
Diffstat (limited to 'README')
-rw-r--r--README42
1 files changed, 42 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..75dc6e7
--- /dev/null
+++ b/README
@@ -0,0 +1,42 @@
+auf.django.secretquestions
+==========================
+
+
+install
+-------
+
+* pip install auf.django.secretquestions
+
+* include 'auf.django.secretquestions.urls' into patterns
+
+* add 'auf.django.secretquestions' to your INSTALLED_APPS
+
+* run syncdb --migrate
+
+
+use
+---
+
+* add decorator to your view : secret_questions_required(ttl=None)
+
+
+configuration
+-------------
+
+* SQ_SESSION_KEY : key for session
+
+* SQ_TOKEN_TTL : global TTL (if not set in the decorator)
+
+
+run tests
+---------
+
+* (optional) create virtualenv environment
+
+* pip install tox
+
+* git clone http://git.auf.org/auf_django_secretquestions.git auf.django.secretquestions
+
+* cd auf.django.secretquestions
+
+* tox