From 1c5ac30265b8cb7d698f9bb69283e0ff175a0a3e Mon Sep 17 00:00:00 2001 From: Alen Mujezinovic Date: Tue, 13 Apr 2010 14:34:02 +0100 Subject: [PATCH] README update --- README.rst | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.rst b/README.rst index 91a7f8a..aecbd64 100644 --- a/README.rst +++ b/README.rst @@ -5,12 +5,17 @@ Django Social Registration Django Social Registration enables developers to add alternative registration methods based on third party sites. +.. note:: + + | v0.3 requires Django 1.2 + | v0.2 requires Django 1.1.1 or earlier + Requirements ============ -django -oauth2 -python-openid -pyfacebook +- django +- oauth2 +- python-openid +- pyfacebook Installation ============ @@ -24,26 +29,21 @@ Configuration Facebook Connect ---------------- -#. Add ``FACEBOOK_API_KEY`` and ``FACEBOOK_SECRET_KEY`` to your settings file -representing the keys you were given by Facebook. +#. Add ``FACEBOOK_API_KEY`` and ``FACEBOOK_SECRET_KEY`` to your settings file representing the keys you were given by Facebook. #. Add ``socialregistration.auth.FacebookAuth`` to ``AUTHENTICATION_BACKENDS`` in your settings file. -#. Add ``facebook.djangofb.FacebookMiddleware`` to ``MIDDLEWARE_CLASSES`` in your settings file. - See: http://wiki.developers.facebook.com/index.php/User:PyFacebook_Tutorial#Add_the_middleware - +#. Add ``facebook.djangofb.FacebookMiddleware`` to ``MIDDLEWARE_CLASSES`` in your settings file. See: http://wiki.developers.facebook.com/index.php/User:PyFacebook_Tutorial#Add_the_middleware #. Add tags to your template file:: {% load facebook_tags %} {% facebook_button %} {% facebook_js %} -#. If you want to use the pyfacebook library to do API calls to Facebook, add - ``socialregistration.middleware.FacebookMiddleware`` to your ``MIDDLEWARE_CLASSES`` setting. +#. If you want to use the pyfacebook library to do API calls to Facebook, add ``socialregistration.middleware.FacebookMiddleware`` to your ``MIDDLEWARE_CLASSES`` setting. Twitter ------- -#. Add the following variables to your ``settings.py`` file with the values you -were given by Twitter:: +#. Add the following variables to your ``settings.py`` file with the values you were given by Twitter:: TWITTER_CONSUMER_KEY TWITTER_CONSUMER_SECRET_KEY @@ -80,11 +80,11 @@ Logging users out You can use the standard {% url auth_logout %} url to log users out of Django. Please note that this will not log users out of third party sites though. When using Facebook Connect, it is recommended to follow the FBConnect developer -wiki -> - http://wiki.developers.facebook.com/index.php/Connect/Authorization_Websites#Logging_Out_Users +wiki. See: http://wiki.developers.facebook.com/index.php/Connect/Authorization_Websites#Logging_Out_Users :: + Logout -To log users out of other third party sites, I recommend redirecting them further to the OAuth / OpenID providers. +To log users out of other third party sites, I recommend redirecting them further to the OAuth / OpenID providers after they logged out of your site. HTTPS -----