Update README.rst

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index f3cd5b53c977725ec03230600b8b757257cc4409..5a4713e8cc0deec9855ede6eba9c83b9abba3358 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,34 +1,18 @@
 ## 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.
+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)
 
 ## 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
+You will need Python 2.7+ and pip.
 
 ```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
-
-```bash
-sudo pip install git+https://github.com/DTVD/rainbowstream.git
+pip install rainbowstream
 ```
 
 ## Usage
@@ -39,6 +23,11 @@ rainbow
 ```
 and see your stream.
 
+In the case you want to see photos directly in terminal, the command is 
+```bash
+rainbow -img 1 # Or rainbow --image 1
+```
+
 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.
 
@@ -74,9 +63,13 @@ __Action Command__
 
 * ```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.