update screenshot
[rainbowstream.git] / README.md
1 ## Rainbow Stream
2 Terminal-based Twitter Client with Streaming API support. Only supports Python 2.7 or later.
3
4 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)
5
6 ## Screenshot
7 ![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png)
8
9 ## Install
10 *The easy way:*
11 * Clone this repo
12 * Create virtualenv (optional but recommended)
13 * Install dependencies
14 * Install the package itself
15
16 ```bash
17 git clone https://github.com/DTVD/rainbowstream.git
18 cd rainbowstream
19 virtualenv venv
20 source venv/bin/activate
21 pip install -r requirements.txt
22 pip install -e .
23 ```
24 *The quick way:*
25 * Install everything over the air
26
27 ```bash
28 pip install -r https://raw.githubusercontent.com/DTVD/rainbowstream/master/requirements.txt
29 pip install git+https://github.com/DTVD/rainbowstream.git
30 ```
31 **Note the I only support Python version 2.7+**
32
33 ## Usage
34 Let's see the rainbow
35 ```bash
36 rainbowstream
37 ```
38
39 ## License
40 Rainbow Stream are released under an MIT License. See below for details
41
42 Copyright (c) 2014 Vu Nhat Minh
43
44 Permission is hereby granted, free of charge, to any person
45 obtaining a copy of this software and associated documentation
46 files (the "Software"), to deal in the Software without
47 restriction, including without limitation the rights to use,
48 copy, modify, merge, publish, distribute, sublicense, and/or sell
49 copies of the Software, and to permit persons to whom the
50 Software is furnished to do so, subject to the following
51 conditions:
52
53 The above copyright notice and this permission notice shall be
54 included in all copies or substantial portions of the Software.
55
56 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
57 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
58 OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
59 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
60 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
61 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
62 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
63 OTHER DEALINGS IN THE SOFTWARE.