X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=cc86e4f8f8166380a85e0c1545649af16bf1224a;hp=7df81d8e91050f2e6bb293fa1d99dc6dbdd12d62;hb=ceec85939c25fe0a6b9d586b3066be4878f2379c;hpb=45e6bb0df0f868a841c41e51e905a679f5ce2015

diff --git a/README.rst b/README.rst
index 7df81d8..cc86e4f 100644
--- a/README.rst
+++ b/README.rst
@@ -10,12 +10,18 @@ Rainbow Stream
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,
 favorite … and much more fun directly from terminal.
 
-This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.
+This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, 
+can run on Python 2.7.x and 3.x .
+
 
 Showcase
 ----------
 Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s
 
+Screenshot: (click to see)
+
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png
+   :alt: all
 
 Install
 -------
@@ -23,11 +29,12 @@ Install
 The quick way
 ^^^^^^^^^^^^^
 
-You will need Python 2.7 and pip.
+You will need Python and pip (2.7.x or 3.x).
 
 .. code:: bash
 
     sudo pip install rainbowstream
+    # Python 3 users: sudo pip3 install rainbowstream
 
 
 The recommended way
@@ -65,6 +72,9 @@ You can try it with:
 
     rainbowstream -iot # Or rainbowstream --image-on-term
 
+You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app 
+to enable above feature (see `config management`_ section).
+
 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.
@@ -119,6 +129,38 @@ Bug and feature requests
 Found a bug or a feature request ?
 Please `create an issue`_ or contact me at `@dtvd88`_
 
+Development
+-----------
+
+If you want to build a runnable version yourself, follow these simple
+steps
+
+-  `Create your own Twitter Application`_
+-  Get your Twitter application’s API key and secret
+-  Fork this repo and clone in your system.
+-  Create a file ``consumer.py`` in `rainbowstream`_ folder with
+   following content
+
+   .. code:: python
+
+       # Consumer information
+       CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
+       CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
+
+-  Use pip to install in local
+
+   .. code:: bash
+
+       # cd to directory which contains setup.py (cloned directory)
+       virtualenv venv # Python3 users: use -p to specify python3
+       source venv/bin/activate
+       pip install -e .
+       which rainbowstream # /this-directory/venv/bin/rainbowstream
+       pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)
+       # Remove ~/.rainbow_oauth if exists
+       rainbowstream # local version of rainbowstream
+
+
 Contributing
 ------------
 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.
@@ -140,4 +182,7 @@ details
 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/
 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md
 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
+.. _Create your own Twitter Application: https://apps.twitter.com/app/new
+.. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream
 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/
+.. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode