autopep8 and bumped version
[rainbowstream.git] / README.rst
index 7df81d8..6ec76fe 100644 (file)
@@ -10,24 +10,31 @@ Rainbow Stream
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
 favorite … and much more fun directly from terminal.\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
+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
 \r
 Showcase\r
 ----------\r
 Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
 \r
+Screenshot: (click to see)\r
 \r
 \r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png\r
+   :alt: all\r
+   \r
 Install\r
 -------\r
 \r
 The quick way\r
 ^^^^^^^^^^^^^\r
 \r
 Install\r
 -------\r
 \r
 The quick way\r
 ^^^^^^^^^^^^^\r
 \r
-You will need Python 2.7 and pip.\r
+You will need Python and pip (2.7.x or 3.x).\r
 \r
 .. code:: bash\r
 \r
     sudo pip install rainbowstream\r
 \r
 .. code:: bash\r
 \r
     sudo pip install rainbowstream\r
+    # Python 3 users: sudo pip3 install rainbowstream\r
 \r
 \r
 The recommended way\r
 \r
 \r
 The recommended way\r
@@ -119,6 +126,38 @@ Bug and feature requests
 Found a bug or a feature request ?\r
 Please `create an issue`_ or contact me at `@dtvd88`_\r
 \r
 Found a bug or a feature request ?\r
 Please `create an issue`_ or contact me at `@dtvd88`_\r
 \r
+Development\r
+-----------\r
+\r
+If you want to build a runnable version yourself, follow these simple\r
+steps\r
+\r
+-  `Create your own Twitter Application`_\r
+-  Get your Twitter application’s API key and secret\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
+\r
+       # Consumer information\r
+       CONSUMER_KEY = 'APIKey' # Your Twitter application's API key\r
+       CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret\r
+\r
+-  Use pip to install in local\r
+\r
+   .. code:: bash\r
+\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
+       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
 Contributing\r
 ------------\r
 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
 Contributing\r
 ------------\r
 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
@@ -140,4 +179,6 @@ details
 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r
 .. _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
 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r
 .. _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
 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r