add list support and seperate help

[rainbowstream.git] / README.rst

diff --git a/README.rst b/README.rst
index b68e8c4e01d4056e0edd560c0bf9004c53b7d867..b73506bc13a75f92dc3b40db85bcef82705a6d54 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -16,13 +16,6 @@ Showcase
 ----------\r
 Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
 \r
-Screenshot:\r
-\r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
-   :alt: rainbowstream\r
-\r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
-   :alt: rainbowstreamIOT\r
 \r
 Install\r
 -------\r
@@ -52,7 +45,7 @@ Just type
 \r
 .. code:: bash\r
 \r
-    rainbow\r
+    rainbowstream\r
 \r
 and see your stream.\r
 \r
@@ -61,7 +54,7 @@ You can try it with:
 \r
 .. code:: bash\r
 \r
-    rainbow -iot # Or rainbow --image-on-term\r
+    rainbowstream -iot # Or rainbowstream --image-on-term\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
@@ -78,9 +71,38 @@ Input is in interactive mode. It means that you can use arrow key to
 move up and down history, tab-autocomplete or 2 tab to view available\r
 suggestion. Input history from previous run is available as well.\r
 \r
-For available commands, please `Read The Docs`_.\r
+Available commands are listed in `Read The Docs`_.\r
+\r
+Theme customization\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
+\r
+Theme’s screenshot:\r
+\r
+- Monokai\r
+\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
+   :alt: monokai\r
+\r
+- Solarized\r
+\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
+   :alt: solarized\r
+\r
+- Tomorrow Night\r
+\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
+   :alt: tomorrownight\r
 \r
-For themes and color setting, see `config guide`_.\r
+- Larapaste\r
+\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
+   :alt: larapaste\r
+\r
+\r
+For detaile information, see `theme usage and customization`_.\r
 \r
 Bug and feature requests\r
 ------------------------\r
@@ -88,6 +110,36 @@ Bug and feature requests
 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 github's repo\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\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
+       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
@@ -107,4 +159,7 @@ details
 .. _fork: https://github.com/DTVD/rainbowstream/fork\r
 .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/\r
 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r
-.. _config guide: #\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