X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=README.md;h=3463819afa32d556eac4b95cb6bd4a2997a2c0d0;hb=53742fea5428a4f3c3dd618e281ed09ca15f60ba;hp=1102f1c2eac6342814f81da9df6470fb60911d4b;hpb=91476ec37e468301d39182aff48936749158e976;p=rainbowstream.git

diff --git a/README.md b/README.md
index 1102f1c..3463819 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,96 @@
 ## Rainbow Stream
+Terminal-based Twitter Client. 
+Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
 
-A rainbow stream console for Twitter.
-Base on Python Twitter Tool
+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
-With python 2.7+ You can:
+You will need Python 2.7+ and pip.
+
 ```bash
-git clone
-pip install requirements.txt
-pip install -e .
+pip install rainbowstream
 ```
 
 ## Usage
+#### The stream
+Just type
 ```bash
-rainbowstream
+rainbow
 ```
+and see your stream.
 
-## Screenshot
+I shipped a feature which can display **tweet's images directly on terminal**.
+You can try it with:
+```bash
+rainbow -iot # Or rainbow --image-on-term
+```
 
+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.
 
-## License
+#### The interactive mode
+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. Input history from previous run is available as well.
+
+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.
 
-Rainbow Stream are released under an MIT License.
+* ```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'*
+
+* ```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 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.
+
+* ```show image 12``` will show the image in tweet with *[id=12]* in your OS's image viewer.
+
+* ```fl @dtvd88```will follow @dtvd88.
+
+* ```ufl @dtvd88```will unfollow @dtvd88.
+
+* ```h```will show the help.
+
+* ```c```will clear the screen.
+
+* ```q```will 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