readme
authorOlivier Larchevêque <olivier.larcheveque@auf.org>
Tue, 13 Aug 2013 18:16:35 +0000 (14:16 -0400)
committerOlivier Larchevêque <olivier.larcheveque@auf.org>
Tue, 13 Aug 2013 18:16:35 +0000 (14:16 -0400)
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
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