bumped veresion
[rainbowstream.git] / README.rst
index 884032e617f22a08216a5c694edf2ad629d901de..976461fabc74da9d613af79b29424db9f98b73ce 100644 (file)
@@ -1,24 +1,25 @@
 Rainbow Stream\r
 --------------\r
 \r
+.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r
+   :target: https://pypi.python.org/pypi/rainbowstream\r
 \r
+.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r
+   :target: https://pypi.python.org/pypi/rainbowstream\r
 \r
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
 favorite … and much more fun directly from terminal.\r
 \r
 This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, \r
-can run on Python 2.7.x and 3.4.x .\r
+can run on Python 2.7.x and 3.x .\r
 \r
 \r
 Showcase\r
-----------\r
-Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
+--------\r
 \r
-Screenshot: (click to see)\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/rs.gif\r
+   :alt: gif\r
 \r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png\r
-   :alt: all\r
-   \r
 Install\r
 -------\r
 \r
@@ -68,6 +69,9 @@ You can try it with:
 \r
     rainbowstream -iot # Or rainbowstream --image-on-term\r
 \r
+You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app \r
+to enable above feature (see `config management`_ section).\r
+\r
 In the first time you will be asked for authorization of Rainbow Stream\r
 app at Twitter. Just click the “Authorize access” button and paste PIN\r
 number to the terminal, the rainbow will start.\r
@@ -86,7 +90,7 @@ suggestion. Input history from previous run is available as well.
 Available commands are listed in `Read The Docs`_.\r
 \r
 Theme customization\r
-------------------------\r
+-------------------\r
 \r
 Rainbow Stream is shipped with some default themes.\r
 You can either change theme by ``theme`` command or create your favorite one.\r
@@ -178,3 +182,4 @@ details
 .. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
 .. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
+.. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode\r