Merge branch 'master' into py3-2

[z_archive/twitter.git] / README

diff --git a/README b/README
index e28beb36c3229795e490725c5a033e722793841f..75a23a4619dec59d6632b88dccb81bcb121aac82 100644 (file)
--- a/README
+++ b/README
@@ -1,4 +1,5 @@
 Python Twitter Tools
 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
 
 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,37 @@ 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.
 
 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` egg:

 
  * 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
 
 
  * 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
+ * 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.
+

 Python Twitter Tools are released under an MIT License.
 Python Twitter Tools are released under an MIT License.