Update README.md

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index f3cd5b53c977725ec03230600b8b757257cc4409..a14986456dacb24c766ac27aaab5cf3ca6d59960 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,34 +1,22 @@
-## Rainbow Stream
-Terminal-based Twitter Client with Streaming API support. 
-Realtime tweetstream, compose, search ... and much more fun directly from terminal.
-Only supports Python 2.7 or later.
+## 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/master/screenshot/RainbowStreamvSS.png)
+![v0.0.1](./screenshot/RainbowStream.png)
+![v0.0.3](./screenshot/RainbowStreamIOT.png)
 
 ## Install
-You will need Python 2.7+ and pip to install
-
-**The recommened way:**
-* Clone this repo
-* Create virtualenv (optional but recommended)
-* Install dependencies
-* Install the package itself
-
-```bash
-git clone git@github.com:DTVD/rainbowstream.git
-cd rainbowstream
-virtualenv venv # Assume that you have virtualenv installed by "pip install virtualenv"
-source venv/bin/activate
-pip install -e .
-```
-**The quick way:**
-* Install everything over the air
+You will need Python 2.7+ and pip.
 
 ```bash
-sudo pip install git+https://github.com/DTVD/rainbowstream.git
+pip install rainbowstream
 ```
 
 ## Usage
@@ -39,14 +27,20 @@ rainbow
 ```
 and see your stream.
 
+I shipped a feature which can display **tweet's images directly on terminal**.
+You can try it with:
+```bash
+rainbow -iot # Or rainbow --image-on-term
+```
+
 In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
 Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
 
 #### 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
 
@@ -66,23 +60,45 @@ 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.
 
+* ```fav 12```will favorite the tweet with *[id=12]*.
+
 * ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.
 
-* ```del 12```will delete thw tweet with *[id=12]*.
+* ```del 12```will delete tweet with *[id=12]*.
+
+* ```ufav 12```will unfavorite tweet with *[id=12]*.
 
 * ```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.