From 0f19f5e3f8fc70d961352398ab7b16e9d817e3b1 Mon Sep 17 00:00:00 2001
From: Alexey Kinyov <rudy@05bit.com>
Date: Sun, 25 Dec 2011 01:15:10 +0300
Subject: [PATCH]  * renames: LICENCE -> LICENSE, LICENCE.django-openid-auth ->
 LICENSE.django-openid-auth  * chapter on basic usage added to README.rst

---
 LICENCE => LICENSE                            |  0
 ...-openid-auth => LICENSE.django-openid-auth |  0
 README.rst                                    | 23 +++++++++++++++++++
 3 files changed, 23 insertions(+)
 rename LICENCE => LICENSE (100%)
 rename LICENCE.django-openid-auth => LICENSE.django-openid-auth (100%)

diff --git a/LICENCE b/LICENSE
similarity index 100%
rename from LICENCE
rename to LICENSE
diff --git a/LICENCE.django-openid-auth b/LICENSE.django-openid-auth
similarity index 100%
rename from LICENCE.django-openid-auth
rename to LICENSE.django-openid-auth
diff --git a/README.rst b/README.rst
index 5626fc6..31ab735 100644
--- a/README.rst
+++ b/README.rst
@@ -323,6 +323,29 @@ Configuration
 
   Defaults to ``LOGIN_ERROR_URL``.
 
+-------------
+Usage example
+-------------
+
+Authentication process starts with ``socialauth_begin`` URL.
+
+Template code example::
+
+    <ul>
+      <li>
+        <a href="{% url socialauth_begin 'twitter' %}">Enter using Twitter</a>
+      </li>
+      <li>
+        <a href="{% url socialauth_begin 'facebook' %}">Enter using Facebook</a>
+      </li>
+    </ul>
+
+In the example above we assume that Twitter and Facebook authentication backends enabled, and following settings provided::
+
+    TWITTER_CONSUMER_KEY = 'real key here'
+    TWITTER_CONSUMER_SECRET = 'real secret here'
+    FACEBOOK_APP_ID = 'real id here'
+    FACEBOOK_API_SECRET = 'real secret here'
 
 -------
 Signals
-- 
2.39.5