Merge remote-tracking branch 'original/master'

[z_archive/twitter.git] / README

diff --git a/README b/README
index 28802238b39c058302a89fdf97358f58aa145b4b..581afa898a4f4c2aa4abc8b55454dd4b306d584d 100644 (file)
--- a/README
+++ b/README
@@ -14,23 +14,17 @@ For more information, after installing the `twitter` package:
 
  * import the `twitter` package and run help() on it
  * run `twitter -h` for command-line tool help
- * run `twitterbot -h` for IRC bot help
- * visit http://mike.verdone.ca/twitter for more info
-
 
 
 twitter - The Command-Line Tool
 -------------------------------
 
-The command-line tool currently supports the following things:
+The command-line tool lets you do some awesome things:
 
- * view your friends' recent tweets
- * view your recent replies
+ * view your tweets, recent replies, and tweets in lists
  * view the public timeline
  * follow and unfollow (leave) friends
- * view tweets from lists
  * various output formats for tweet information
- * read your username and password from a config file
 
 The bottom line: type `twitter`, receive tweets.
 
@@ -53,6 +47,13 @@ tweets from a given user in a simple text format. It is useful to get
 a complete offsite backup of all your tweets. Run `twitter-log` and
 read the instructions.
 
+twitter-archiver and twitter-follow
+-----------------------------------
+
+twitter-archiver will log all the tweets posted by any user since they
+started posting. twitter-follow will print a list of all of all the
+followers of a user (or all the users that user follows).
+
 
 Programming with the Twitter api classes
 ========================================
@@ -76,9 +77,13 @@ The Twitter API is documented at:
 
 
 Examples::
+    
+    from twitter import *
 
+    # see "Authentication" section below for tokens and keys
     t = Twitter(
-        auth=OAuth(token, token_key, con_secret, con_secret_key)))
+        auth=OAuth(OAUTH_TOKEN, OAUTH_SECRET,
+                   CONSUMER_KEY, CONSUMER_SECRET)))
 
     # Get the public timeline
     t.statuses.public_timeline()
@@ -108,6 +113,8 @@ Examples::
 
 Searching Twitter::
 
+    from twitter import *
+
     twitter_search = Twitter(domain="search.twitter.com")
 
     # Find the latest search trends
@@ -212,6 +219,8 @@ strings in the file. Not terribly exciting.
 Finally, you can use the OAuth authenticator to connect to Twitter. In
 code it all goes like this::
 
+    from twitter import *
+
     MY_TWITTER_CREDS = os.path.expanduser('~/.my_app_credentials')
     if not os.path.exists(MY_TWITTER_CREDS):
         oauth_dance("My App Name", CONSUMER_KEY, CONSUMER_SECRET,
@@ -220,7 +229,7 @@ code it all goes like this::
     oauth_token, oauth_secret = read_token_file(MY_TWITTER_CREDS)
 
     twitter = Twitter(auth=OAuth(
-        oauth_token, oauth_token_secret, CONSUMER_KEY, CONSUMER_SECRET))
+        oauth_token, oauth_secret, CONSUMER_KEY, CONSUMER_SECRET))
 
     # Now work with Twitter
     twitter.statuses.update('Hello, world!')