Update README.rst
[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
19Screenshot: \r
20\r
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
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
34 sudo pip install rainbowstream\r
35 \r
36or try with a virtualenv\r
37\r
38.. code:: bash\r
39\r
40 sudo pip install virtualenv # skip if you already have virtualenv\r
41 virtualenv venv \r
42 source venv/bin/activate # use the brand new virtualenv.\r
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
59I shipped a feature which can display **tweet's images directly on terminal**.\r
60You can try it with:\r
61\r
62.. code:: bash\r
63\r
64 rainbow -iot # Or rainbow --image-on-term\r
65\r
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
68number to the terminal, the rainbow will start.\r
69\r
70The interactive mode\r
71--------------------\r
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
75the Enter key to see the help.\r
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
79suggestion. Input history from previous run is available as well.\r
80\r
81For available commands, please `Read The Docs`_.\r
82\r
83For themes and color setting, see `config guide`_.\r
84\r
85Bug and feature requests\r
86------------------------\r
87\r
88Found a bug or a feature request ? \r
89Please `create an issue`_ or contact me at `@dtvd88`_\r
90\r
91Contributing\r
92------------\r
93I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
94You will be listed as contributor.\r
95\r
96License\r
97-------\r
98\r
99Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
100details\r
101\r
102\r
103.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
104.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
105.. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
106.. _@dtvd88: https://twitter.com/dtvd88\r
107.. _fork: https://github.com/DTVD/rainbowstream/fork\r
108.. _create a pull request: https://github.com/DTVD/rainbowstream/compare/\r
109.. _Read The Dics: http://rainbowstream.readthedocs.org/en/latest/\r
110.. _config guide: #\r