Use cases doc section. Closes #239

diff --git a/README.rst b/README.rst
index 5ac4447bcddab0552c70c4fe98bc9923a27300ad..4e8c69ba3e0084fa91b485ed29c1528505738958 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -810,11 +810,27 @@ fill the needed account information. Then run::
     cd contrib/tests
     ./runtests.py
 
+---------
+Use Cases
+---------
+Some particular use cases are listed below.
+
+1. Use social auth just for account association (no login)::
+
+    urlpatterns += patterns('',
+        url(r'^associate/(?P<backend>[^/]+)/$', associate,
+            name='socialauth_associate_begin'),
+        url(r'^associate/complete/(?P<backend>[^/]+)/$', associate_complete,
+            name='socialauth_associate_complete'),
+        url(r'^disconnect/(?P<backend>[^/]+)/$', disconnect,
+            name='socialauth_disconnect'),
+        url(r'^disconnect/(?P<backend>[^/]+)/(?P<association_id>[^/]+)/$',
+            disconnect, name='socialauth_disconnect_individual'),
+    )
 
 -------------
 Miscellaneous
 -------------
-
 Join to django-social-auth_ community on Convore_ and bring any questions or
 suggestions that will improve this app.
 

diff --git a/doc/index.rst b/doc/index.rst
index 68921aeff6f35a858ac557c1890a3f7f719cb751..0bec67ad21e4d39d8f55da4fcb26a7251ccf7853 100644 (file)
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -22,6 +22,7 @@ Contents:
    signals
    contributions
    testing
+   use_cases
    miscellaneous
    bugs
 

diff --git a/doc/use_cases.rst b/doc/use_cases.rst
new file mode 100644 (file)
index 0000000..daec210
--- /dev/null
+++ b/doc/use_cases.rst
@@ -0,0 +1,17 @@
+Use Cases
+=========
+
+Some particular use cases are listed below.
+
+1. Use social auth just for account association (no login)::
+
+    urlpatterns += patterns('',
+        url(r'^associate/(?P<backend>[^/]+)/$', associate,
+            name='socialauth_associate_begin'),
+        url(r'^associate/complete/(?P<backend>[^/]+)/$', associate_complete,
+            name='socialauth_associate_complete'),
+        url(r'^disconnect/(?P<backend>[^/]+)/$', disconnect,
+            name='socialauth_disconnect'),
+        url(r'^disconnect/(?P<backend>[^/]+)/(?P<association_id>[^/]+)/$',
+            disconnect, name='socialauth_disconnect_individual'),
+    )