X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=README.md;h=1e67659d3a499e01a8eeefd5dbfc98da3cada83e;hb=4d4f7d28a7c6faec1e61791aca5df94bbb2f7f4b;hp=63b97041250bbf0630a0ba93c5636a889736028b;hpb=4b39ea814ff8b2c76411b7095e72ee9c071c7304;p=rainbowstream.git

diff --git a/README.md b/README.md
index 63b9704..1e67659 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,16 @@
 ## Rainbow Stream
-Terminal-based Twitter Client. 
+
+[![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)
+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](https://raw.githubusercontent.com/DTVD/rainbowstream/develop/screenshot/RainbowStreamvSS(Image).png)
+![rainbowstream](./screenshot/RainbowStream.png)
+![rainbowstreamIOT](./screenshot/RainbowStreamIOT.png)
 
 ## Install
 You will need Python 2.7+ and pip.
@@ -22,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.
@@ -32,60 +38,101 @@ 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
 
-__Stream Command__
-* ```switch public #AKB48``` will switch current stream to public stream and track keyword ```AKB48```
+__Explore Commands__
+
+* `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.
+
+* `mentions` will show mentions timeline. `mentions 7` will show 7 mention tweets.
+
+* `whois @dtvd88` will show profile of @dtvd88.
+
+* `view @mdo` will show @mdo 's timeline. `view @dmo 9` will print exactly 9 tweets.
+
+* `s #noah` will search the word *'noah'*. Result will come back with highlight.
+
+__Tweet Commands__
+
+* `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.
+
+* `rep 12 Really` will reply *'Really'* to the tweet with *[id=12]*.
+
+* `fav 12` will favorite the tweet with *[id=12]*.
+
+* `ufav 12` will unfavorite tweet with *[id=12]*.
+
+* `del 12` will delete tweet with *[id=12]*.
+
+* `show image 12` will show the image in tweet with *[id=12]* in your OS's image viewer.
+
+__Direct Messages Commands__
+
+* `inbox` will show inbox messages. `inbox 7` will show newest 7 messages.
+
+* `sent` will show sent messages. `sent 7` will show newest 7 messages.
+
+* `mes @dtvd88 hi` will send a `hi` message to @dtvd88.
+
+* `trash 5` will remove message with *[message_id=5]*
+
+__Friends and followers Commands__
+
+* `ls fl` will list all your followers (people who are following you).
 
-* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
+* `ls fr` will list all your friends (people who you are following).
 
-    ```Only nicks``` decide what nicks will be include only.
+* `fl @dtvd88` will follow @dtvd88.
 
-    ```Ignore nicks```decide what nicks will be exclude.
+* `ufl @dtvd88` will unfollow @dtvd88.
 
-* ```switch public #AKB48 -d ``` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
-You can setup 2 list above at ```config.py```
+* `mute @dtvd88` will mute @dtvd88.
 
-* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.
+* `unmute @dtvd88` will unmute @dtvd88.
 
-__Action Command__
+* `muting` will list muting users.
 
-* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
+* `block @dtvd88` will block @dtvd88.
 
-* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
+* `unblock @dtvd88` will unblock @dtvd88.
 
-* ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*
+* `report @dtvd88` will report @dtvd88 as a spam account.
 
-* ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
+__Screening Commands__
 
-* ```fav 12```will favorite the tweet with *[id=12]*.
+* `h` will show the help.
 
-* ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.
+* `c` will clear the screen.
 
-* ```del 12```will delete tweet with *[id=12]*.
+* `q` will quit.
 
-* ```ufav 12```will unfavorite tweet with *[id=12]*.
+__Switching Stream Commands__
 
-* ```s #noah```will search the word *'noah'*. Result will come back with highlight.
+* `switch public #AKB48` will switch current stream to public stream and track keyword `AKB48`
 
-* ```fr```will list all friend (You are following people).
+* `switch public #AKB48 -f ` will do exactly as above but will ask you to provide 2 list:
 
-* ```fl```will list all follower.
+    `Only nicks` decide what nicks will be include only.
 
-* ```h```will show the help.
+    `Ignore nicks`decide what nicks will be exclude.
 
-* ```c```will clear the screen.
+* `switch public #AKB48 -d ` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
+You can setup 2 list above at `config.py`
 
-* ```q```will quit.
+* `switch mine` will switch current stream to personal stream. `-f` and `-d` will work as well.
 
 For example see the screenshot above.
 
 ## Bug Report
-Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new) 
+Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
 or contact me at [@dtvd88](https://twitter.com/dtvd88)
 
 ## License