Merge pull request #214 from edi-bice/master

[z_archive/twitter.git] / README

diff --git a/README b/README
index 225e5cb770a2577e015e6e0e78a52bc07f286390..18de04e1ef3e89a1cd3cb13b02825a54f501da36 100644 (file)
--- a/README
+++ b/README
@@ -78,7 +78,7 @@ The Twitter API is documented at:
 
 Examples::
 
-```python 
+```python
 from twitter import *
 
 # see "Authentication" section below for tokens and keys
@@ -91,10 +91,13 @@ t = Twitter(
 t.statuses.home_timeline()
 
 # Get a particular friend's timeline
-t.statuses.friends_timeline(id="billybob")
+t.statuses.user_timeline(screen_name="billybob")
+
+# to pass in GET/POST parameters, such as `count`
+t.statuses.home_timeline(count=5)
 
-# Also supported (but totally weird)
-t.statuses.friends_timeline.billybob()
+# to pass in the GET/POST parameter `id` you need to use `_id`
+t.statuses.oembed(_id=1234567890)
 
 # Update your status
 t.statuses.update(
@@ -116,8 +119,13 @@ t.user.list.members(user="tamtar", list="things-that-are-rad")
 # calls which take much more time than normal or twitter stops
 # responding for some reasone
 t.users.lookup(screen_name=','.join(A_LIST_OF_100_SCREEN_NAMES), _timeout=1)
-```
 
+# Overriding Method: GET/POST
+# you should not need to use this method as this library properly
+# detects whether GET or POST should be used, Nevertheless
+# to force a particular method, use `_method`
+t.statuses.oembed(_id=1234567890, _method='GET')
+```
 
 Searching Twitter::
 
@@ -180,6 +188,38 @@ The `block` parameter controls if the stream is blocking. Default
 is blocking (True). When set to False, the iterator will
 occasionally yield None when there is no available message.
 
+Per default the ``TwitterStream`` object uses
+[public streams](https://dev.twitter.com/docs/streaming-apis/streams/public).
+If you want to use one of the other
+[streaming APIs](https://dev.twitter.com/docs/streaming-apis), specify the URL
+manually:
+
+- [Public streams](https://dev.twitter.com/docs/streaming-apis/streams/public): stream.twitter.com
+- [User streams](https://dev.twitter.com/docs/streaming-apis/streams/user): userstream.twitter.com
+- [Site streams](https://dev.twitter.com/docs/streaming-apis/streams/site): sitestream.twitter.com
+
+Note that you require the proper
+[permissions](https://dev.twitter.com/docs/application-permission-model) to
+access these streams. E.g. for direct messages your
+[application](https://dev.twitter.com/apps) needs the "Read, Write & Direct
+Messages" permission.
+
+The following example demonstrates how to retreive all new direct messages
+from the user stream:
+
+```python
+auth = OAuth(
+    consumer_key='[your consumer key]',
+    consumer_secret='[your consumer secret]',
+    token='[your token]',
+    token_secret='[your token secret]'
+)
+twitter_userstream = TwitterStream(auth=auth, domain='userstream.twitter.com')
+for msg in twitter_userstream.user():
+    if 'direct_message' in msg:
+        print msg['direct_message']['text']
+```
+
 Twitter Response Objects
 ------------------------
 
@@ -215,7 +255,7 @@ to do this. Please see the twitter.oauth_dance module to see how this
 is done. If you are making a command-line app, you can use the
 oauth_dance() function directly.
 
-Performing the "oauth dance" gets you an ouath token and oauth secret
+Performing the "oauth dance" gets you an oauth token and oauth secret
 that authenticate the user with Twitter. You should save these for
 later so that the user doesn't have to do the oauth dance again.
 
@@ -240,7 +280,7 @@ twitter = Twitter(auth=OAuth(
     oauth_token, oauth_secret, CONSUMER_KEY, CONSUMER_SECRET))
 
 # Now work with Twitter
-twitter.statuses.update('Hello, world!')
+twitter.statuses.update(status='Hello, world!')
 ```