X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.md;h=0a5b44d9f55f33c8f27ed38d4bfc704346dd0a10;hp=1102f1c2eac6342814f81da9df6470fb60911d4b;hb=7a00142fbd8716d040603cba7c27000e2673be25;hpb=91476ec37e468301d39182aff48936749158e976;ds=sidebyside

diff --git a/README.md b/README.md
index 1102f1c..0a5b44d 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,45 @@
 ## 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.
 
-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/RainbowStreamv0.0.1.png)
 
 ## Install
-With python 2.7+ You can:
+**The recommened way:**
+* Clone this repo
+* Create virtualenv (optional but recommended)
+* Install dependencies
+* Install the package itself
+
 ```bash
-git clone
-pip install requirements.txt
+git clone https://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 .
 ```
+**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
 ```bash
-rainbowstream
+rainbow
 ```
+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.
 
-## Screenshot
+While the rainbow stream is continued, you can search, reply, retweet, tweet directly from terminal ...
+Type 'h' to view full help or use TAB auto-completion to see what is available. 
 
 
 ## License
-
-Rainbow Stream are released under an MIT License.
+Rainbow Stream are released under an MIT License. See LICENSE.txt for details