add help
[rainbowstream.git] / README.md
CommitLineData
91476ec3 1## Rainbow Stream
c7ef0402
O
2Terminal-based Twitter Client with Streaming API support.
3Realtime tweetstream, compose, search ... and much more fun directly from terminal.
4Only supports Python 2.7 or later.
cd300211
O
5
6This 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)
f5dcec85
O
7
8## Screenshot
9![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png)
91476ec3
O
10
11## Install
c7ef0402 12**The recommened way:**
c267927c 13* Clone this repo
f5dcec85 14* Create virtualenv (optional but recommended)
c267927c
O
15* Install dependencies
16* Install the package itself
17
91476ec3 18```bash
c267927c
O
19git clone https://github.com/DTVD/rainbowstream.git
20cd rainbowstream
4ec25373 21virtualenv venv # Assume that you have virtualenv installed by "pip install virtualenv"
f5dcec85 22source venv/bin/activate
91476ec3
O
23pip install -e .
24```
4ec25373 25**The quick way:**
c267927c
O
26* Install everything over the air
27
28```bash
4ec25373 29sudo pip install git+https://github.com/DTVD/rainbowstream.git
c267927c
O
30```
31**Note the I only support Python version 2.7+**
91476ec3
O
32
33## Usage
34```bash
35rainbowstream
36```
9f72f0f5 37In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
4e2680f6 38Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
91476ec3 39
7b2f82ad 40While the rainbow stream is continued, you can search, reply, retweet, tweet directly from terminal ...
c7ef0402
O
41Type 'h' to view help or see screenshot above.
42
7b2f82ad 43
f5dcec85 44## License
13b5b854 45Rainbow Stream are released under an MIT License. See LICENSE.txt for details