using south for db migrations

[django-cas-provider.git] / README.rst

diff --git a/README.rst b/README.rst
index 9e922c6..a2bd475 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -5,8 +5,12 @@ django-cas-provider
 OVERVIEW
 =========
 
-django-cas-provider is a provider for the `Central Authentication Service <http://jasig.org/cas>`_. It supports CAS version 1.0 and parts of CAS version 2.0 protocol. 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>`_.
+django-cas-provider is a provider for the `Central Authentication Service <http://jasig.org/cas>`_. It supports 
+CAS version 1.0 and CAS version 2.0 protocol. 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
 =============
@@ -42,6 +46,10 @@ used to format custom user attributes. This package provide module `attribute_fo
 with formatters for common used formats. Available formats styles are `RubyCAS`, `Jasig`
 and `Name-Value. Default is Jasig style. See module source code for more details.
 
+CAS_AUTO_REDIRECT_AFTER_LOGOUT - If False (default behavior, specified in CAS protocol)
+after successful logout notification page will be shown. If it's True, after successful logout will
+be auto redirect back to service without any notification.
+
 
 PROTOCOL DOCUMENTATION
 =====================
@@ -88,18 +96,30 @@ Optional arguments:
 validate
 -------------
 
-It checks the validity of a service ticket. It is part of the CAS 1.0 protocol and thus does
+It checks the validity of a Service ticket. It is part of the CAS 1.0 protocol and thus does
 not handle proxy authentication.
 
-It has not arguments. 
+It has no arguments. 
 
 service_validate
 -------------------------
 
-It checks the validity of a service ticket and returns an XML-fragment response via CAS 2.0 protocol.
-Work with proxy is not supported yet.
+It checks the validity of a Service Ticket and returns an XML-fragment response via CAS 2.0 protocol.
+
+It has no arguments.
+
+proxy_validate
+-------------------------
+
+It checks the validity of a Proxy Ticket and returns an XML-fragment response via CAS 2.0 protocol.
+
+It has no arguments.
+
+proxy
+-------------------------
+Creates a proxy ticket for a given Proxy Granting Ticket.
 
-It has not arguments.
+It has no arguments.
 
 
 CUSTOM USER ATTRIBUTES FORMAT