Update README.rst

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index 326a287cce9a1b5719ed23a63cfcdaf1c439e87f..5a4713e8cc0deec9855ede6eba9c83b9abba3358 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,34 +1,19 @@
 ## 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
-**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 .
+pip install rainbowstream
 ```
-**The quick way:**
-* Install everything over the air
-
-```bash
-sudo pip install git+https://github.com/DTVD/rainbowstream.git
-```
-**Note the I only support Python version 2.7+**
 
 ## Usage
 #### The stream
@@ -38,17 +23,38 @@ 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.
 
 #### The interactive mode
-While the rainbow stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
-Simply hit Enter key and type "h" to view the help
+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
 
 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
 
 Here is full list of supported command
 
+__Stream Command__
+* ```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.
+
+__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.
@@ -57,9 +63,13 @@ Here is full list of supported 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.