Update README.md

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index b58095e7fc598d36a77583f6f242a97bf5a868d3..a14986456dacb24c766ac27aaab5cf3ca6d59960 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
-![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/develop/screenshot/RainbowStreamvSS.png)
-![v0.0.2](https://raw.githubusercontent.com/DTVD/rainbowstream/develop/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.
@@ -23,9 +27,10 @@ rainbow
 ```
 and see your stream.
 
-In the case you want to see photos directly in terminal, the command is 
+I shipped a feature which can display **tweet's images directly on terminal**.
+You can try it with:
 ```bash
-rainbow -img 1 # or rainbow --image 1
+rainbow -iot # Or rainbow --image-on-term
 ```
 
 In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
@@ -33,9 +38,9 @@ Just click the "Authorize access" button and paste PIN number to the terminal, t
 
 #### The interactive mode
 While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
-Simply type "h" and hit the Enter key to see the help
+Simply type "h" and hit the Enter key to see the help.
 
-Input is in interactive mode. It means that you can use arrow key to move up and down history, tab-autocomplete or 2 tab to view available suggestion
+Input is in interactive mode. It means that you can use arrow key to move up and down history, tab-autocomplete or 2 tab to view available suggestion. Input history from previous run is available as well.
 
 Here is full list of supported command
 
@@ -55,11 +60,13 @@ You can setup 2 list above at ```config.py```
 
 __Action Command__
 
-* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
+* ```home```will show your timeline. ```home 10``` will print exactly 10 tweets.
+
+* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweets.
 
-* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
+* ```mentions```will show mentions timeline. ```mentions 7``` will show 7 mention tweets.
 
-* ```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.
 
@@ -73,9 +80,25 @@ __Action Command__
 
 * ```s #noah```will search the word *'noah'*. Result will come back with highlight.
 
-* ```fr```will list all friend (You are following people).
+* ```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).
+
+* ```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.
 
-* ```fl```will list all follower.
+* ```ufl @dtvd88```will unfollow @dtvd88.
 
 * ```h```will show the help.