X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=4dafa8572e64640b3f248e84f3beadc1ea854c93;hp=7727f720c57ed94c7aaa6fb1813c4ce60e6d69f7;hb=b9eeb635b2a477abf9a166a01c582b76ccafc182;hpb=9ee4a3cc95dcf0a00193655e5b543a36ce835198 diff --git a/README.rst b/README.rst index 7727f72..4dafa85 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,10 @@ Rainbow Stream -------------- -.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat - :target: https://pypi.python.org/pypi/rainbowstream +.. image:: http://img.shields.io/pypi/l/rainbowstream.svg?style=flat-square + :target: https://github.com/DTVD/rainbowstream/blob/master/LICENSE.txt -.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat +.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat-square :target: https://pypi.python.org/pypi/rainbowstream Terminal-based Twitter Client. Realtime tweetstream, compose, search , @@ -13,6 +13,9 @@ favorite … and much more fun directly from terminal. This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, can run on Python 2.7.x and 3.x . +Home page : http://www.rainbowstream.org/ + +Source code : https://github.com/DTVD/rainbowstream Showcase -------- @@ -42,7 +45,7 @@ Use `virtualenv`_ .. code:: bash virtualenv venv - # Python 3 users : use -p to specify your Python 3 localtion as below + # Python 3 users : use -p to specify your Python 3 location as below # virtualenv -p /usr/bin/python3 venv source venv/bin/activate pip install rainbowstream @@ -55,7 +58,7 @@ For debian-based distros, these can be installed with .. code:: bash - sudo apt-get install python-dev libjpeg libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev + sudo apt-get install python-dev libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with the ``Pillow`` package installation - a dependency of this app. @@ -105,6 +108,18 @@ In the first time you will be asked for authorization of Rainbow Stream app at Twitter. Just click the “Authorize access” button and paste PIN number to the terminal, the rainbow will start. +You might want to use rainbowstream via an **HTTP/SOCKS proxy**. Proxy settings are +provided as follows: + +.. code:: bash + + rainbowstream --proxy-host localhost --proxy-port 1337 --proxy-type HTTP + # or using the short form: + rainbowstream -ph localhost -pp 1337 -pt HTTP + +Both ``--proxy-port`` and ``--proxy-type`` can be omitted. In this case default +proxy port ``8080`` and default proxy type ``SOCKS5`` are used. + The interactive mode ^^^^^^^^^^^^^^^^^^^^ @@ -146,7 +161,7 @@ Theme’s screenshot: .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png :alt: larapaste -For detaile information, see `theme usage and customization`_. +For detail information, see `theme usage and customization`_. Bug and feature requests