Update README.md
[rainbowstream.git] / README.rst
CommitLineData
3108149e 1Rainbow Stream\r
2--------------\r
3\r
3216f3f4
O
4.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r
5 :target: https://pypi.python.org/pypi/rainbowstream\r
6\r
7.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r
8 :target: https://pypi.python.org/pypi/rainbowstream\r
c96321cc 9\r
3108149e 10Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
11favorite … and much more fun directly from terminal.\r
12\r
3216f3f4 13This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r
3108149e 14\r
456019d6 15Showcase\r
3108149e 16----------\r
b84845b9 17Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
456019d6 18\r
b84845b9 19Screenshot:\r
3108149e 20\r
3216f3f4
O
21.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
22 :alt: rainbowstream\r
23\r
24.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
25 :alt: rainbowstreamIOT\r
3108149e 26\r
27Install\r
28-------\r
29\r
30You will need Python 2.7+ and pip.\r
31\r
32.. code:: bash\r
33\r
fd9cd791 34 sudo pip install rainbowstream\r
b84845b9 35\r
a011e0e2 36or try with a virtualenv\r
fd9cd791
O
37\r
38.. code:: bash\r
39\r
40 sudo pip install virtualenv # skip if you already have virtualenv\r
b84845b9 41 virtualenv venv\r
fd9cd791 42 source venv/bin/activate # use the brand new virtualenv.\r
3108149e 43 pip install rainbowstream\r
44\r
45Usage\r
46-----\r
47\r
48The stream\r
49^^^^^^^^^^\r
50\r
51Just type\r
52\r
53.. code:: bash\r
54\r
55 rainbow\r
56\r
57and see your stream.\r
58\r
3216f3f4
O
59I shipped a feature which can display **tweet's images directly on terminal**.\r
60You can try it with:\r
4373c17c
O
61\r
62.. code:: bash\r
63\r
c1fa7c94 64 rainbow -iot # Or rainbow --image-on-term\r
4373c17c 65\r
3108149e 66In the first time you will be asked for authorization of Rainbow Stream\r
67app at Twitter. Just click the “Authorize access” button and paste PIN\r
3216f3f4 68number to the terminal, the rainbow will start.\r
3108149e 69\r
70The interactive mode\r
c1a3d5e5 71--------------------\r
3108149e 72\r
73While your personal stream is continued, you are also ready to tweet,\r
74search, reply, retweet… directly from console. Simply type “h” and hit\r
f5677fb1 75the Enter key to see the help.\r
3108149e 76\r
77Input is in interactive mode. It means that you can use arrow key to\r
78move up and down history, tab-autocomplete or 2 tab to view available\r
f5677fb1 79suggestion. Input history from previous run is available as well.\r
3108149e 80\r
b913cd75 81Available commands are listed in `Read The Docs`_.\r
3108149e 82\r
b913cd75
O
83Theme customization\r
84------------------------\r
85\r
86Rainbow Stream is shipped with some default themes. \r
87You can either change theme by ``theme`` command or create your favorite one.\r
88\r
89For detaile information, see `theme usage and customization`_.\r
3108149e 90\r
050c4214 91Bug and feature requests\r
36e1924e 92------------------------\r
3108149e 93\r
b84845b9 94Found a bug or a feature request ?\r
3216f3f4 95Please `create an issue`_ or contact me at `@dtvd88`_\r
3108149e 96\r
050c4214 97Contributing\r
36e1924e 98------------\r
050c4214
O
99I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
100You will be listed as contributor.\r
101\r
3108149e 102License\r
103-------\r
104\r
105Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
106details\r
107\r
108\r
109.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
bade45d4 110.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
3108149e 111.. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
3216f3f4 112.. _@dtvd88: https://twitter.com/dtvd88\r
050c4214
O
113.. _fork: https://github.com/DTVD/rainbowstream/fork\r
114.. _create a pull request: https://github.com/DTVD/rainbowstream/compare/\r
670e8049 115.. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r
b52327dc 116.. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
b913cd75 117.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r