Update README.md
[rainbowstream.git] / README.md
index 359bc96117a32654d0da7f257a304e68f3737c20..8c1039af2546fa65ad0de4a140519f29f02e4a69 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,11 +6,11 @@
 Terminal-based Twitter Client. 
 Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
 
-This package build on the top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter Streaming API](https://dev.twitter.com/docs/api/streaming) and inspired by [EarthQuake](https://github.com/jugyo/earthquake)
+This package is built on top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter API](https://dev.twitter.com/docs/api/1.1).
 
 ## Screenshot
-![v0.0.1](./screenshot/RainbowStream.png)
-![v0.0.3](./screenshot/RainbowStreamIOT.png)
+![rainbowstream](./screenshot/RainbowStream.png)
+![rainbowstreamIOT](./screenshot/RainbowStreamIOT.png)
 
 ## Install
 You will need Python 2.7+ and pip.
@@ -44,21 +44,9 @@ Input is in interactive mode. It means that you can use arrow key to move up and
 
 Here is full list of supported command
 
-__Stream Command__
-* ```switch public #AKB48``` will switch current stream to public stream and track keyword ```AKB48```
-
-* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
-
-    ```Only nicks``` decide what nicks will be include only.
-
-    ```Ignore nicks```decide what nicks will be exclude.
+__Action Commands__
 
-* ```switch public #AKB48 -d ``` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
-You can setup 2 list above at ```config.py```
-
-* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.
-
-__Action Command__
+* ```trend```will show global trending topics. ```trend US``` will show trends in United States while ```trend JP Tokyo``` will show trends in Tokyo/Japan.
 
 * ```home```will show your timeline. ```home 10``` will print exactly 10 tweets.
 
@@ -80,6 +68,8 @@ __Action Command__
 
 * ```s #noah```will search the word *'noah'*. Result will come back with highlight.
 
+* ```mes @dtvd88 hi```will send a ```hi``` message to @dtvd88.
+
 * ```show image 12``` will show the image in tweet with *[id=12]* in your OS's image viewer.
 
 * ```ls fl```will list all your followers (people who are following you).
@@ -104,6 +94,21 @@ __Action Command__
 
 * ```q```will quit.
 
+__Stream Commands__
+
+* ```switch public #AKB48``` will switch current stream to public stream and track keyword ```AKB48```
+
+* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
+
+    ```Only nicks``` decide what nicks will be include only.
+
+    ```Ignore nicks```decide what nicks will be exclude.
+
+* ```switch public #AKB48 -d ``` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
+You can setup 2 list above at ```config.py```
+
+* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.
+
 For example see the screenshot above.
 
 ## Bug Report