From d87d0fe9586f004cef9c6ef32efc88f0d9b73079 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Mat=C3=ADas=20Aguirre?= Date: Thu, 9 Feb 2012 14:17:47 -0200 Subject: [PATCH] Use cases doc section. Closes #239 --- README.rst | 18 +++++++++++++++++- doc/index.rst | 1 + doc/use_cases.rst | 17 +++++++++++++++++ 3 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 doc/use_cases.rst diff --git a/README.rst b/README.rst index 5ac4447..4e8c69b 100644 --- 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[^/]+)/$', associate, + name='socialauth_associate_begin'), + url(r'^associate/complete/(?P[^/]+)/$', associate_complete, + name='socialauth_associate_complete'), + url(r'^disconnect/(?P[^/]+)/$', disconnect, + name='socialauth_disconnect'), + url(r'^disconnect/(?P[^/]+)/(?P[^/]+)/$', + 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 68921ae..0bec67a 100644 --- 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 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[^/]+)/$', associate, + name='socialauth_associate_begin'), + url(r'^associate/complete/(?P[^/]+)/$', associate_complete, + name='socialauth_associate_complete'), + url(r'^disconnect/(?P[^/]+)/$', disconnect, + name='socialauth_disconnect'), + url(r'^disconnect/(?P[^/]+)/(?P[^/]+)/$', + disconnect, name='socialauth_disconnect_individual'), + ) -- 2.39.5