From: Kenneth Reitz <me@kennethreitz.com>
Date: Mon, 14 Feb 2011 05:39:16 +0000 (-0500)
Subject: Documentation update
X-Git-Tag: v0.2.0~21
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=2b54b01ce2726a04f155ef29637b0d5011f965e2;p=services%2Fpython-requests.git

Documentation update
---

diff --git a/README.rst b/README.rst
index 9c38fcb..7aed0aa 100644
--- a/README.rst
+++ b/README.rst
@@ -39,62 +39,49 @@ Usage
 It couldn't be simpler. ::
 
 	>>> import requests
+	>>> r = requests.get('http://google.com')
+
+
+HTTPS? Basic Authentication? ::
 	
-	>>> request.get(url, params={}, headers={} auth=None)
-	<response object>
+	>>> r = requests.get('https://convore.com/api/account/verify.json')
+	>>> r.status_code
+	401
+
 	
-	>>> request.put(url, params={}, headers={}, auth=None)
-	<response object>
+Uh oh, we're not authorized! Let's add authentication. ::
 	
-	>>> request.post(url, params={}, headers={}, auth=None)
-	<response object>
+	>>> conv_auth = requests.AuthObject('requeststest', 'requeststest')
+	>>> r = requests.get('https://convore.com/api/account/verify.json', conv_auth=auth)
 	
-	>>> request.delete(url, params={}, headers={}, auth=None)
-	<response object>
+	>>> r.status_code
+	200 
 	
+	>>> r.headers['content-type']
+	application/json
 	
-	>>> r = request.Request()
+	>>> r.content
+	{"username": "requeststest", "url": "/users/requeststest/", "id": "9408", "img": "censored-long-url"}
+
+
+
+API
+---
 	
-	>>> r.url = 'http://someurl.com/'
-	>>> r.add_header(('key', 'value'))
+	>>> request.get(url, params={}, headers={} auth=None)
+	<response object>
 	
-	>>> r.method = 'GET'
+	>>> request.head(url, params={}, headers={} auth=None)
+	<response object>
 	
-	>>> r.send()
-	True
-
-	>>> dict(r)
-	{
-		'url': 'http://someurl.com/',
-		'headers': {
-			'key': 'value',
-		}, 
-		'method': 'GET',
-		'response': {
-			'content': <sensored-content>,
-			'status_code': 200,
-			'headers': {
-				'x-runtime': '210ms',
-				'server': 'Apache 2.1',
-				'Content-Type': 'text/html; charset=utf-8'
-			}
-		}
-	}
+	>>> request.put(url, data='', headers={}, auth=None)
+	<response object>
 	
-Access stuff. ::
-
-	>>> r = request.get('https://github.com')
-	>>> r.response.status_code()
-
-HTTP Authentication. ::
-
-	>>> whoiam = AuthObject('xxx-username', 'xxx-pass')
-	>>> request.get(url, params{}, auth=whoiam)
-
-"Opener" System. ::
-
-	# all containing given url will automatically auth with given AuthObject
-	>>> requests.add_autoauth(url, auth)
+	>>> request.post(url, data={}, headers={}, auth=None)
+	<response object>
+	
+	>>> request.delete(url, params={}, headers={}, auth=None)
+	<response object>
 	
 
 
@@ -111,14 +98,18 @@ Or, if you absolutely must: ::
 
 But, you really shouldn't do that.
    
+
+
 Contribute
 ----------
 
 If you'd like to contribute, simply fork `the repository`_, commit your changes to the **develop** branch (or branch off of it), and send a pull request. Make sure you add yourself to AUTHORS_.
 
 
+
 Roadmap
 -------
+
 - Documentation
 - Write it!
 - Test it!