Additional documentation and cleaned up imports in views.py

[django-cas-provider.git] / README

diff --git a/README b/README
index 4cc70b3..2568ad0 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,27 @@
 django-cas-provider
-
 Chris Williams <chris@nitron.org>
 
-TODO: Write documentation
+OVERVIEW:
+       django-cas-provider is a provider for the Central Authentication 
+Service (http://jasig.org/cas). 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 http://www.ja-sig.org/wiki/display/CAS/Home
+and 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 (templates/cas/login.html and templates/cas/logout.html).
+