delete debug

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index 38db40f8a65714f5b8f945b6fa69501bf213c5d1..0a5b44d9f55f33c8f27ed38d4bfc704346dd0a10 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 ## Rainbow Stream
 ## Rainbow Stream

-Terminal-based Twitter Client with Streaming API support. Only supports Python 2.7 or later.
+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.

 
 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)
 
 
 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)
 


@@ -7,7 +9,7 @@ This package build on the top of [Python Twitter Tool](http://mike.verdone.ca/tw
 ![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png)
 
 ## Install
 ![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png)
 
 ## Install

-*The easy way:*
+**The recommened way:**

 * Clone this repo
 * Create virtualenv (optional but recommended)
 * Install dependencies
 * Clone this repo
 * Create virtualenv (optional but recommended)
 * Install dependencies


@@ -16,48 +18,28 @@ This package build on the top of [Python Twitter Tool](http://mike.verdone.ca/tw
 ```bash
 git clone https://github.com/DTVD/rainbowstream.git
 cd rainbowstream
 ```bash
 git clone https://github.com/DTVD/rainbowstream.git
 cd rainbowstream

-virtualenv venv
+virtualenv venv # Assume that you have virtualenv installed by "pip install virtualenv"

 source venv/bin/activate
 source venv/bin/activate

-pip install -r requirements.txt

 pip install -e .
 ```
 pip install -e .
 ```

-*The quick way:*
+**The quick way:**

 * Install everything over the air
 
 ```bash
 * 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
+sudo pip install git+https://github.com/DTVD/rainbowstream.git

 ```
 **Note the I only support Python version 2.7+**
 
 ## Usage
 ```
 **Note the I only support Python version 2.7+**
 
 ## Usage

-Let's see the rainbow

 ```bash
 ```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.
+
+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
 
 ## 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.
+Rainbow Stream are released under an MIT License. See LICENSE.txt for details