Update README.md
[rainbowstream.git] / README.rst
... / ...
CommitLineData
1Rainbow Stream\r
2--------------\r
3\r
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
9\r
10Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
11favorite … and much more fun directly from terminal.\r
12\r
13This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r
14\r
15Showcase\r
16----------\r
17Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
18\r
19\r
20Install\r
21-------\r
22\r
23The quick way\r
24^^^^^^^^^^^^^\r
25\r
26You will need Python 2.7 and pip.\r
27\r
28.. code:: bash\r
29\r
30 sudo pip install rainbowstream\r
31\r
32\r
33The recommended way\r
34^^^^^^^^^^^^^^^^^^^\r
35\r
36Use `virtualenv`_\r
37\r
38.. code:: bash\r
39\r
40 virtualenv venv\r
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
44 pip install rainbowstream\r
45\r
46\r
47Usage\r
48-----\r
49\r
50The stream\r
51^^^^^^^^^^\r
52\r
53Just type\r
54\r
55.. code:: bash\r
56\r
57 rainbowstream\r
58\r
59and see your stream.\r
60\r
61I shipped a feature which can display **tweet's images directly on terminal**.\r
62You can try it with:\r
63\r
64.. code:: bash\r
65\r
66 rainbowstream -iot # Or rainbowstream --image-on-term\r
67\r
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
70number to the terminal, the rainbow will start.\r
71\r
72The interactive mode\r
73--------------------\r
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
77the Enter key to see the help.\r
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
81suggestion. Input history from previous run is available as well.\r
82\r
83Available commands are listed in `Read The Docs`_.\r
84\r
85Theme customization\r
86------------------------\r
87\r
88Rainbow Stream is shipped with some default themes.\r
89You can either change theme by ``theme`` command or create your favorite one.\r
90\r
91Theme’s screenshot:\r
92\r
93- Monokai\r
94\r
95.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
96 :alt: monokai\r
97\r
98- Solarized\r
99\r
100.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
101 :alt: solarized\r
102\r
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
114For detaile information, see `theme usage and customization`_.\r
115\r
116Bug and feature requests\r
117------------------------\r
118\r
119Found a bug or a feature request ?\r
120Please `create an issue`_ or contact me at `@dtvd88`_\r
121\r
122Contributing\r
123------------\r
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
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
135.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
136.. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
137.. _@dtvd88: https://twitter.com/dtvd88\r
138.. _fork: https://github.com/DTVD/rainbowstream/fork\r
139.. _create a pull request: https://github.com/DTVD/rainbowstream/compare/\r
140.. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r
141.. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
142.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
143.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r