add filter
[rainbowstream.git] / README.md
index 8638c02..603a3c3 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
 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
 
 ## Install
+You will need Python 2.7+ and pip to install
+
 **The recommened way:**
 * Clone this repo
 * Create virtualenv (optional but recommended)
 **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
 * 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
 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
 ```
 ```bash
 sudo pip install git+https://github.com/DTVD/rainbowstream.git
 ```
-**Note the I only support Python version 2.7+**
 
 ## Usage
 #### The stream
 
 ## Usage
 #### The stream
@@ -49,66 +50,35 @@ Input is in interactive mode. It means that you can use arrow key to move up and
 
 Here is full list of supported command
 
 
 Here is full list of supported command
 
-```bash
-[@dtvd88]home 
-```
-Show your timeline. A number come after will decide number of tweets to print. Ex 'home 10'.
+* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
 
 
-```bash
-[@dtvd88]view @mdo 
-```
-Show @mdo 's timeline.
+* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
 
 
-```bash
-[@dtvd88]t the rainbow is god's promise to noah
-```
-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'*
 
 
-```bash
-[@dtvd88]rt 1
-```
-Retweet the tweet with [id=1]. You can see id of each tweet beside the time.
+* ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
 
 
-```bash
-[@dtvd88]rep 1 Really
-```
-Reply 'Really' to the tweet with [id=1].
+* ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.
 
 
-```bash
-[@dtvd88]del 1
-```
-Delete thw tweet with [id=1].
+* ```del 12```will delete thw tweet with *[id=12]*.
 
 
-```bash
-[@dtvd88]s #noah
-```
-Search the word 'noah'. Result will come back with highlight.
+* ```s #noah```will search the word *'noah'*. Result will come back with highlight.
 
 
-```bash
-[@dtvd88]fr
-```
-List all friend (You are following people).
+* ```fr```will list all friend (You are following people).
 
 
-```bash
-[@dtvd88]fl
-```
-List all follower.
+* ```fl```will list all follower.
 
 
-```bash
-[@dtvd88]h
-```
-SHow the help.
+* ```h```will show the help.
 
 
-```bash
-[@dtvd88]c
-```
-Clear the screen.
+* ```c```will clear the screen.
 
 
+* ```q```will quit.
 
 
-```bash
-[@dtvd88]q
-```
-Quit.
+For example see the screenshot above.
+
+## Bug Report
+Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new) 
+or contact me at [@dtvd88](https://twitter.com/dtvd88)
 
 ## License
 Rainbow Stream are released under an MIT License. See LICENSE.txt for details
 
 ## License
 Rainbow Stream are released under an MIT License. See LICENSE.txt for details