Skip to content
Browse files

Added a bit of README

  • Loading branch information...
1 parent 1b7b98b commit 1db8e264337f6d4a8e8f9d80230ceb971976ab95 @pennersr committed Oct 13, 2010
Showing with 49 additions and 4 deletions.
  1. +1 −0 .gitignore
  2. +4 −3 AUTHORS
  3. +44 −1 README.rst
View
1 .gitignore
@@ -1 +1,2 @@
*.pyc
+*~
View
7 AUTHORS
@@ -1,3 +1,4 @@
-django-allauth was started by Raymond Penners in October 2010,
-inspired by and partly based on existing projects such as Pinax
-(account app), Django-Socialauth, django-socialregistration.
+django-allauth was started by Raymond Penners
+(<raymond.penners@intenct.nl> or @pennersr) in October 2010, inspired
+by and partly based on existing projects such as Pinax (account app),
+Django-Socialauth, django-socialregistration.
View
45 README.rst
@@ -1,2 +1,45 @@
-TBD
+==============
+Django AllAuth
+==============
+Integrated set of Django applications addressing authentication,
+registration, account management as well as 3rd party (social) account
+authentication.
+
+Configuration
+=============
+
+Django
+------
+
+settings.py:
+
+ TEMPLATE_CONTEXT_PROCESSORS = (
+ ...
+ "allauth.account.context_processors.account"
+ )
+
+ AUTHENTICATION_BACKENDS = ('django.contrib.auth.backends.ModelBackend',
+ 'allauth.socialaccount.auth.SocialAccountBackend')
+
+ INSTALLED_APPS = (
+ 'allauth',
+ 'allauth.account',
+ 'allauth.socialaccount',
+ 'allauth.twitter',
+ 'allauth.openid',
+ 'allauth.facebook',
+
+urls.py:
+
+ urlpatterns = patterns('',
+ ...
+ (r'^accounts/', include('allauth.urls')))
+
+
+Facebook & Twitter
+------------------
+
+The required keys and secrets for interacting with Facebook and
+Twitter are to be configured in the database via the Django admin
+using the TwitterApp and FacebookApp models.

0 comments on commit 1db8e26

Please sign in to comment.
Something went wrong with that request. Please try again.