Update README.md
[rainbowstream.git] / README.md
index e76d0ac..000f66a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,6 +9,8 @@ This package build on the top of [Python Twitter Tool](http://mike.verdone.ca/tw
 ![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
@@ -49,6 +50,22 @@ Input is in interactive mode. It means that you can use arrow key to move up and
 
 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.