Update README.rst
[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
3216f3f4 19\r
3108149e 20Install\r
21-------\r
22\r
45e6bb0d
O
23The quick way\r
24^^^^^^^^^^^^^\r
25\r
26You will need Python 2.7 and pip.\r
3108149e 27\r
28.. code:: bash\r
29\r
fd9cd791 30 sudo pip install rainbowstream\r
b84845b9 31\r
45e6bb0d
O
32\r
33The recommended way\r
34^^^^^^^^^^^^^^^^^^^\r
35\r
36Use `virtualenv`_\r
fd9cd791
O
37\r
38.. code:: bash\r
39\r
b84845b9 40 virtualenv venv\r
45e6bb0d
O
41 # Python 3 users : use -p to specify your Python 3 localtion as below\r
42 # virtualenv -p /usr/bin/python3 venv\r
43 source venv/bin/activate\r
3108149e 44 pip install rainbowstream\r
45\r
45e6bb0d 46\r
3108149e 47Usage\r
48-----\r
49\r
50The stream\r
51^^^^^^^^^^\r
52\r
53Just type\r
54\r
55.. code:: bash\r
56\r
9f37426f 57 rainbowstream\r
3108149e 58\r
59and see your stream.\r
60\r
3216f3f4
O
61I shipped a feature which can display **tweet's images directly on terminal**.\r
62You can try it with:\r
4373c17c
O
63\r
64.. code:: bash\r
65\r
9f37426f 66 rainbowstream -iot # Or rainbowstream --image-on-term\r
4373c17c 67\r
3108149e 68In the first time you will be asked for authorization of Rainbow Stream\r
69app at Twitter. Just click the “Authorize access” button and paste PIN\r
3216f3f4 70number to the terminal, the rainbow will start.\r
3108149e 71\r
72The interactive mode\r
c1a3d5e5 73--------------------\r
3108149e 74\r
75While your personal stream is continued, you are also ready to tweet,\r
76search, reply, retweet… directly from console. Simply type “h” and hit\r
f5677fb1 77the Enter key to see the help.\r
3108149e 78\r
79Input is in interactive mode. It means that you can use arrow key to\r
80move up and down history, tab-autocomplete or 2 tab to view available\r
f5677fb1 81suggestion. Input history from previous run is available as well.\r
3108149e 82\r
b913cd75 83Available commands are listed in `Read The Docs`_.\r
3108149e 84\r
b913cd75
O
85Theme customization\r
86------------------------\r
87\r
06302419 88Rainbow Stream is shipped with some default themes.\r
b913cd75
O
89You can either change theme by ``theme`` command or create your favorite one.\r
90\r
547283bf 91Theme’s screenshot:\r
19d6c002 92\r
06302419
O
93- Monokai\r
94\r
547283bf
O
95.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
96 :alt: monokai\r
19d6c002 97\r
06302419
O
98- Solarized\r
99\r
547283bf
O
100.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
101 :alt: solarized\r
102\r
98258022
O
103- Tomorrow Night\r
104\r
105.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
106 :alt: tomorrownight\r
107\r
108- Larapaste\r
109\r
110.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
111 :alt: larapaste\r
112\r
113\r
b913cd75 114For detaile information, see `theme usage and customization`_.\r
3108149e 115\r
050c4214 116Bug and feature requests\r
36e1924e 117------------------------\r
3108149e 118\r
b84845b9 119Found a bug or a feature request ?\r
3216f3f4 120Please `create an issue`_ or contact me at `@dtvd88`_\r
3108149e 121\r
050c4214 122Contributing\r
36e1924e 123------------\r
050c4214
O
124I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
125You will be listed as contributor.\r
126\r
3108149e 127License\r
128-------\r
129\r
130Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
131details\r
132\r
133\r
134.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
bade45d4 135.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
3108149e 136.. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
3216f3f4 137.. _@dtvd88: https://twitter.com/dtvd88\r
050c4214
O
138.. _fork: https://github.com/DTVD/rainbowstream/fork\r
139.. _create a pull request: https://github.com/DTVD/rainbowstream/compare/\r
670e8049 140.. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r
b52327dc 141.. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
b913cd75 142.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
45e6bb0d 143.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r