X-Git-Url: https://git.mdrn.pl/django-cas-provider.git/blobdiff_plain/788f43bed3a5919a533d7e963f5729633a9c3197..c4e951ccbda6275dd5134a431af7e0ee8f129feb:/README.rst

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..0677574
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,38 @@
+===================
+django-cas-provider
+===================
+
+---------------------------------
+Chris Williams <chris@nitron.org>
+---------------------------------
+
+OVERVIEW
+=========
+
+django-cas-provider is a provider for the `Central Authentication 
+Service <http://jasig.org/cas>`_. It supports CAS version 1.0. It allows 
+remote services to authenticate users for the purposes of 
+Single Sign-On (SSO). For example, a user logs into a CAS server 
+(provided by django-cas-provider) and can then access other services 
+(such as email, calendar, etc) without re-entering her password for
+each service. For more details, see the `CAS wiki <http://www.ja-sig.org/wiki/display/CAS/Home>`_
+and `Single Sign-On on Wikipedia <http://en.wikipedia.org/wiki/Single_Sign_On>`_.
+
+INSTALLATION
+=============
+
+To install, run the following command from this directory:
+
+		``python setup.py install``
+
+Or, put cas_provider somewhere on your Python path.
+	
+USAGE
+======
+
+#. Add ``'cas_provider'`` to your ``INSTALLED_APPS`` tuple in *settings.py*.
+#. In *settings.py*, set ``LOGIN_URL`` to ``'/cas/login/'`` and ``LOGOUT_URL`` to ``'/cas/logout/'``
+	before they expire. Default: 5 minutes
+#. In *urls.py*, put the following line:
+    ``(r'^cas/', include('cas_provider.urls')),``
+#. Create login/logout templates (or modify the samples)