update screenshot

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index 1102f1c2eac6342814f81da9df6470fb60911d4b..38db40f8a65714f5b8f945b6fa69501bf213c5d1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,24 +1,63 @@
 ## Rainbow Stream
+Terminal-based Twitter Client with Streaming API support. 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 easy 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
+source venv/bin/activate
+pip install -r requirements.txt
 pip install -e .
 ```
+*The quick way:*
+* Install everything over the air
+
+```bash
+pip install -r https://raw.githubusercontent.com/DTVD/rainbowstream/master/requirements.txt
+pip install git+https://github.com/DTVD/rainbowstream.git
+```
+**Note the I only support Python version 2.7+**
 
 ## Usage
+Let's see the rainbow
 ```bash
 rainbowstream
 ```
 
-## Screenshot
+## License
+Rainbow Stream are released under an MIT License. See below for details
 
+Copyright (c) 2014 Vu Nhat Minh
 
-## License
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
-Rainbow Stream are released under an MIT License.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.