Update README.rst
[rainbowstream.git] / README.md
index 77f9abddfcdcf6e1a9c201470933ad2a0794b732..c9d4ad78f2a91200183d845fb4fab1e3835faaa7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ Realtime tweetstream, compose, search , favorite ... and much more fun directly
 This package is built on top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter API](https://dev.twitter.com/docs/api/1.1).
 
 ## Showcase
-Screencast: 
+Screencast:
 https://www.youtube.com/watch?v=tykCvPMJq8s
 <br>
 
@@ -28,7 +28,7 @@ sudo pip install rainbowstream
 or try with a virtualenv
 ```bash
 sudo pip install virtualenv # skip if you already have virtualenv
-virtualenv venv 
+virtualenv venv
 source venv/bin/activate # use the brand new virtualenv.
 pip install rainbowstream
 ```
@@ -38,14 +38,14 @@ pip install rainbowstream
 #### The stream
 Just type
 ```bash
-rainbow
+rainbowstream
 ```
 and see your stream.
 
 I shipped a feature which can display **tweet's images directly on terminal**.
 You can try it with:
 ```bash
-rainbow -iot # Or rainbow --image-on-term
+rainbowstream -iot # Or rainbowstream --image-on-term
 ```
 
 In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
@@ -58,19 +58,33 @@ Simply type "h" and hit the Enter key to see the help.
 
 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 suggestion. Input history from previous run is available as well.
 
-For available commands, please [Read The Docs](http://rainbowstream.readthedocs.org/en/latest/).
+Available commands are listed in [Read The Docs](http://rainbowstream.readthedocs.org/en/latest/) .
 
-For themes and color setting, see [config guide](#).
+## Theme customization
+Rainbow Stream is shipped with some default themes.
+You can either change theme by `theme` command or create your favorite one.
+
+Theme's screenshot:
+* Monokai
+![Monokai](./screenshot/themes/Monokai.png)
+* Solarized
+![Solarized](./screenshot/themes/Solarized.png)
+* Tomorrow Night
+![Solarized](./screenshot/themes/TomorrowNight.png)
+* Larapaste
+![Solarized](./screenshot/themes/larapaste.png)
+
+For detaile information, see [theme usage and customization](https://github.com/DTVD/rainbowstream/blob/master/theme.md)
 
 ## Bug and feature requests
-Found a bug or a feature request ? 
+Found a bug or a feature request ?
 Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
 or contact me at [@dtvd88](https://twitter.com/dtvd88)
 
 ## Contributing
-I appreciate any help and support. Feel free to 
-[fork](https://github.com/DTVD/rainbowstream/fork) 
-and 
+I appreciate any help and support. Feel free to
+[fork](https://github.com/DTVD/rainbowstream/fork)
+and
 [create a pull request](https://github.com/DTVD/rainbowstream/compare/).
 You will be listed as contributor.