Update README.md
[rainbowstream.git] / README.md
1 ## Rainbow Stream
2
3 [![Download](http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
4 [![Version](http://img.shields.io/pypi/v/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
5
6 Terminal-based Twitter Client.
7 Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
8
9 This package is built on top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter API](https://dev.twitter.com/docs/api/1.1).
10
11 ## Showcase
12 Screencast:
13 https://www.youtube.com/watch?v=tykCvPMJq8s
14 <br>
15
16 Screenshot:
17 ![rainbowstream](./screenshot/RainbowStream.png)
18 ![rainbowstreamIOT](./screenshot/RainbowStreamIOT.png)
19
20
21 ## Install
22 You will need Python 2.7+ and pip.
23
24 ```bash
25 sudo pip install rainbowstream
26 ```
27
28 or try with a virtualenv
29 ```bash
30 sudo pip install virtualenv # skip if you already have virtualenv
31 virtualenv venv
32 source venv/bin/activate # use the brand new virtualenv.
33 pip install rainbowstream
34 ```
35
36
37 ## Usage
38 #### The stream
39 Just type
40 ```bash
41 rainbowstream
42 ```
43 and see your stream.
44
45 I shipped a feature which can display **tweet's images directly on terminal**.
46 You can try it with:
47 ```bash
48 rainbowstream -iot # Or rainbowstream --image-on-term
49 ```
50
51 In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
52 Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
53
54 ## Interactive mode
55
56 While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
57 Simply type "h" and hit the Enter key to see the help.
58
59 Input is in interactive mode. It means that you can use arrow key to move up and down history, tab-autocomplete or 2 tab to view available suggestion. Input history from previous run is available as well.
60
61 Available commands are listed in [Read The Docs](http://rainbowstream.readthedocs.org/en/latest/) .
62
63 ## Theme customization
64 Rainbow Stream is shipped with some default themes.
65 You can either change theme by `theme` command or create your favorite one.
66
67 Theme's screenshot:
68 * Monokai
69 ![Monokai](./screenshot/themes/Monokai.png)
70 * Solarized
71 ![Solarized](./screenshot/themes/Solarized.png)
72 * Tomorrow Night
73 ![Solarized](./screenshot/themes/TomorrowNight.png)
74 * Larapaste
75 ![Solarized](./screenshot/themes/larapaste.png)
76
77 For detaile information, see [theme usage and customization](https://github.com/DTVD/rainbowstream/blob/master/theme.md)
78
79 ## Bug and feature requests
80 Found a bug or a feature request ?
81 Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
82 or contact me at [@dtvd88](https://twitter.com/dtvd88)
83
84 ## Contributing
85 I appreciate any help and support. Feel free to
86 [fork](https://github.com/DTVD/rainbowstream/fork)
87 and
88 [create a pull request](https://github.com/DTVD/rainbowstream/compare/).
89 You will be listed as contributor.
90
91 ## License
92 Rainbow Stream are released under an MIT License. See LICENSE.txt for details