fix typo

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index 69c00bcddaceef2da2dc23636a1bb8f3606896ee..0b8114b2fc42290287e4898a5d5ce0355f35982f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,15 +1,23 @@
 ## Rainbow Stream
-This is a Twitter timeline on the terminal, base on Python Twitter Tool
+Terminal-based Twitter Client with Streaming API support. 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
+![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png)
 
 ## Install
 *The easy way:*
 * Clone this repo
+* Create virtualenv (optional but recommended)
 * Install dependencies
 * Install the package itself
 
 ```bash
 git clone https://github.com/DTVD/rainbowstream.git
 cd rainbowstream
+virtualenv venv
+source venv/bin/activate
 pip install -r requirements.txt
 pip install -e .
 ```
@@ -23,13 +31,35 @@ 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
 ```
+In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
 
-## Screenshot
-
+Allow access and enter granted PIN number to terminal so the home timeline stream will be start.
 
 ## License
-Rainbow Stream are released under an MIT License.
+Rainbow Stream are released under an MIT License. See below for details
+
+Copyright (c) 2014 Vu Nhat Minh
+
+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.
+
+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.