initial doc index
authorKenneth Reitz <me@kennethreitz.com>
Sun, 15 May 2011 16:43:34 +0000 (12:43 -0400)
committerKenneth Reitz <me@kennethreitz.com>
Sun, 15 May 2011 16:43:34 +0000 (12:43 -0400)
docs/index.rst

index 46b12447c13b9f5e953f3305dfadc12a426dc0ea..7d6b51d40324127abac74466d1965d4985f6f056 100644 (file)
@@ -3,8 +3,45 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Requests's documentation!
-====================================
+Requests: Python HTTP (That Doesn't Suck)!
+==========================================
+
+Release |version|.
+
+Requests is an :ref:`ISC Licensed <usc>` HTTP library, written in Python.
+
+Most existing Python modules for sending HTTP requests are insane. This one strives to focus on the 95% use case: Simply sending the requests.
+
+GET, HEAD, PUT, POST, DELETE.
+
+
+How Simple?
+-----------
+
+
+requests
+~~~~~~~~
+
+::
+
+    import requests
+    requests.get('https://convore.com/api', auth=('username', 'password'))
+
+
+urllib2
+~~~~~~~
+
+::
+
+    # complicated.
+
+
+I recommend you start with :ref:`Installation <install>`.
+
+
+
+
+
 
 Contents: