Update README.md

[rainbowstream.git] / README.rst

diff --git a/README.rst b/README.rst
index 982eed9a5c09f3f28ff0fdba695961801ab0cfe0..5574e6949e32ea0af8a764f14d1b8c33a09b40ab 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -14,16 +14,13 @@ This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.
 \r
 Showcase\r
 ----------\r
-Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s \r
+Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
 \r
-Screenshot: \r
+Screenshot:\r
 \r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.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
 \r
@@ -32,13 +29,13 @@ You will need Python 2.7+ and pip.
 .. code:: bash\r
 \r
     sudo pip install rainbowstream\r
-    \r
+\r
 or try with a virtualenv\r
 \r
 .. code:: bash\r
 \r
     sudo pip install virtualenv # skip if you already have virtualenv\r
-    virtualenv venv \r
+    virtualenv venv\r
     source venv/bin/activate # use the brand new virtualenv.\r
     pip install rainbowstream\r
 \r
@@ -52,7 +49,7 @@ Just type
 \r
 .. code:: bash\r
 \r
-    rainbow\r
+    rainbowstream\r
 \r
 and see your stream.\r
 \r
@@ -61,7 +58,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,14 +75,43 @@ 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
+- Larapaste\r
+\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
+   :alt: larapaste\r
+\r
 \r
-For themes and color setting, see `config guide`_.\r
+For detaile information, see `theme usage and customization`_.\r
 \r
 Bug and feature requests\r
 ------------------------\r
 \r
-Found a bug or a feature request ? \r
+Found a bug or a feature request ?\r
 Please `create an issue`_ or contact me at `@dtvd88`_\r
 \r
 Contributing\r
@@ -107,4 +133,5 @@ 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