Add license and more info to the README

1 files changed, 33 insertions, 3 deletions

diff --git a/README.rst b/README.rst
index 741a540..8992084 100644
--- a/README.rst
+++ b/README.rst
@@ -1,8 +1,10 @@
 uritemplate
 ===========
 
-Simple python library to deal with `URI Templates`_. When complete the API 
-should look something like::
+Documentation_ -- GitHub_ -- BitBucket_
+
+Simple python library to deal with `URI Templates`_. The API should looks 
+like::
 
     from uritemplate import URITemplate, expand
 
@@ -16,6 +18,34 @@ should look something like::
 
     # also
     t.expand({'gist_id': 123456})
-    expand(gist_uri, {'gist_id': 123456})
+    print(expand(gist_uri, {'gist_id': 123456}))
+
+Where it might be useful to have a class::
+
+    import requests
+
+    class GitHubUser(object):
+        url = URITemplate('https://api.github.com/user{/login}')
+        def __init__(self, name):
+            self.api_url = url.expand(login=name)
+            response = requests.get(self.api_url)
+            if response.status_code == 200:
+                self.__dict__.update(response.json())
+
+When the module containing this class is loaded, ``GitHubUser.url`` is 
+evaluated and so the template is created once. It's often hard to notice in 
+Python, but object creation can consume a great deal of time and so can the 
+``re`` module which uritemplate relies on. Constructing the object once should 
+reduce the amount of time your code takes to run.
+
+License
+-------
+
+Modified BSD license_
+
 
+.. _Documentation: https://uritemplate.rtfd.org/
+.. _GitHub: https://github.com/sigmavirus24/uritemplate
+.. _BitBucket: https://bitbucket.org/icordasc/uritemplate
 .. _URI Templates: http://tools.ietf.org/html/rfc6570
+.. _license: ./LICENSE