Update index.rst

[rainbowstream.git] / README.rst

diff --git a/README.rst b/README.rst
index ee15eb5bfd4a1bd5effc77d4050b4e93189a7705..cc86e4f8f8166380a85e0c1545649af16bf1224a 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -10,12 +10,18 @@ Rainbow Stream
 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
+This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, \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
+Screenshot: (click to see)\r
+\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png\r
+   :alt: all\r
 \r
 Install\r
 -------\r
@@ -66,6 +72,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
@@ -128,8 +137,8 @@ steps
 \r
 -  `Create your own Twitter Application`_\r
 -  Get your Twitter application’s API key and secret\r
--  Fork github's repo\r
--  Create a file ``consumer.py`` in ```rainbowstream```_ folder with\r
+-  Fork this repo and clone in your system.\r
+-  Create a file ``consumer.py`` in `rainbowstream`_ folder with\r
    following content\r
 \r
    .. code:: python\r
@@ -142,11 +151,13 @@ steps
 \r
    .. code:: bash\r
 \r
-       # cd to directory which contains setup.py\r
+       # cd to directory which contains setup.py (cloned directory)\r
        virtualenv venv # Python3 users: use -p to specify python3\r
        source venv/bin/activate\r
        pip install -e .\r
-       pip list | grep rainbowstream # confirm installed version\r
+       which rainbowstream # /this-directory/venv/bin/rainbowstream\r
+       pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)\r
+       # Remove ~/.rainbow_oauth if exists\r
        rainbowstream # local version of rainbowstream\r
 \r
 \r
@@ -172,5 +183,6 @@ details
 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
 .. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
-.. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\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