fix help

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index 3463819afa32d556eac4b95cb6bd4a2997a2c0d0..b505ee727e3ae01146439357dba4488b0e11fd25 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,16 @@
-## Rainbow Stream
+## Rainbow Stream 
+
+[![Download](http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
+[![Version](http://img.shields.io/pypi/v/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
+

 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)
 
 ## Screenshot
 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)
 
 ## Screenshot

-![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamvSS.png)
-![v0.0.2](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamvSS(Image).png)
+![v0.0.1](./screenshot/RainbowStream.png)
+![v0.0.3](./screenshot/RainbowStreamIOT.png)

 
 ## Install
 You will need Python 2.7+ and pip.
 
 ## Install
 You will need Python 2.7+ and pip.


@@ -40,27 +44,17 @@ Input is in interactive mode. It means that you can use arrow key to move up and
 
 Here is full list of supported command
 
 
 Here is full list of supported command
 

-__Stream Command__
-* ```switch public #AKB48``` will switch current stream to public stream and track keyword ```AKB48```
+__Action Commands__

 
 

-* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
+* ```trend```will show global trending topic. ```trend US``` will show trends in United States while ```trend JP Tokyo``` will show trends in Tokyo/Japan.

 
 

-    ```Only nicks``` decide what nicks will be include only.
+* ```home```will show your timeline. ```home 10``` will print exactly 10 tweets.

 
 

-    ```Ignore nicks```decide what nicks will be exclude.
+* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweets.

 
 

-* ```switch public #AKB48 -d ``` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
-You can setup 2 list above at ```config.py```
+* ```mentions```will show mentions timeline. ```mentions 7``` will show 7 mention tweets.

 
 

-* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.
-
-__Action Command__
-
-* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
-
-* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
-
-* ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*
+* ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*.

 
 * ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
 
 
 * ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
 


@@ -74,8 +68,22 @@ __Action Command__
 
 * ```s #noah```will search the word *'noah'*. Result will come back with highlight.
 
 
 * ```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.
 
 * ```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).
+
+* ```ls fr```will list all your friends (people who you are following).
+
+* ```inbox```will show inbox messages. ```inbox 7``` will show newest 7 messages.
+
+* ```sent```will show sent messages. ```sent 7``` will show newest 7 messages.
+
+* ```trash 5```will remove message with *[message_id=5]*
+
+* ```whois @dtvd88```will show profile of @dtvd88.
+

 * ```fl @dtvd88```will follow @dtvd88.
 
 * ```ufl @dtvd88```will unfollow @dtvd88.
 * ```fl @dtvd88```will follow @dtvd88.
 
 * ```ufl @dtvd88```will unfollow @dtvd88.


@@ -86,6 +94,21 @@ __Action Command__
 
 * ```q```will quit.
 
 
 * ```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
 For example see the screenshot above.
 
 ## Bug Report