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