Merge pull request #28 from thameera/patch-1

[rainbowstream.git] / README.rst

diff --git a/README.rst b/README.rst
index 3736626935e153e5d2c065d8aac90f668ab85129..461a2e1346c6366a7ebade55bf0c1eee76ab9839 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -11,21 +11,26 @@ Terminal-based Twitter Client. Realtime tweetstream, compose, search ,
 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
+Requirements\r
+^^^^^^^^^^^^\r
+\r
+If you use Linux, you might need to install the ``python-dev`` and \r
+``libsqlite3-dev`` packages if you haven't already. For debian-based distros, \r
+these can be installed with ``sudo apt-get install python-dev libsqlite3-dev``.\r
+\r
+\r
 The quick way\r
 ^^^^^^^^^^^^^\r
 \r
@@ -72,6 +77,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
@@ -90,7 +98,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
@@ -182,3 +190,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