Update README.md
[rainbowstream.git] / README.md
index f87a7ff..f3cd5b5 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,9 +6,11 @@ Only supports Python 2.7 or later.
 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/RainbowStreamv0.0.1.png)
+![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamvSS.png)
 
 ## Install
+You will need Python 2.7+ and pip to install
+
 **The recommened way:**
 * Clone this repo
 * Create virtualenv (optional but recommended)
@@ -16,7 +18,7 @@ This package build on the top of [Python Twitter Tool](http://mike.verdone.ca/tw
 * Install the package itself
 
 ```bash
-git clone https://github.com/DTVD/rainbowstream.git
+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
@@ -28,7 +30,6 @@ pip install -e .
 ```bash
 sudo pip install git+https://github.com/DTVD/rainbowstream.git
 ```
-**Note the I only support Python version 2.7+**
 
 ## Usage
 #### The stream
@@ -42,26 +43,42 @@ In the first time you will be asked for authorization of Rainbow Stream app at T
 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
 
-* ```home```will show your timeline. A number come after will decide number of tweets to print. Ex ```home 10```.
+__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``` also print 9 tweet exactly.
+* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
 
-* ```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.
 
-* ```rep 12 Really```will reply **'Really'** to 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]*.
 
-* ```s #noah```will search the word **'noah'**. Result will come back with highlight.
+* ```s #noah```will search the word *'noah'*. Result will come back with highlight.
 
 * ```fr```will list all friend (You are following people).