- Check rate limit using the command line tool. Patch by @stalkr_

[z_archive/twitter.git] / README

diff --git a/README b/README
index e28beb36c3229795e490725c5a033e722793841f..3d6b1806f9efb54889b70990c4bce6a1ff707151 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,5 @@
 Python Twitter Tools
+====================
 
 The Minimalist Twitter API for Python is a Python API for Twitter,
 everyone's favorite Web 2.0 Facebook-style status updater for people
@@ -9,11 +10,49 @@ tweets and setting your own tweet from the safety and security of your
 favorite shell and an IRC bot that can announce Twitter updates to an
 IRC channel.
 
-For more information:
+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
 
+
+ 
+The Command-Line Tool
+=====================
+
+The command-line tool currently supports the following things:
+
+ * view your friends' recent tweets
+ * view your recent replies
+ * 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.
+
+
+
+The IRC Bot
+===========
+
+The IRC bot is associated with a twitter account (either your own account or an
+account you create for the bot). The bot announces all tweets from friends
+it is following. It can be made to follow or leave friends through IRC /msg
+commands.
+
+
+
+twitter-log
+===========
+
+`twitter-log` is a simple command-line tool that dumps all public
+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.
+
+
 Python Twitter Tools are released under an MIT License.