bumped v0.2.6

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index 13a751f40a022de3fa638f057dda85ec0628a9de..d5b53effba1c8df9a810a94df7d2f1b4ab25ea1a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,10 +13,8 @@ Screencast:
 https://www.youtube.com/watch?v=tykCvPMJq8s
 <br>
 
-Screenshot:
-![rainbowstream](./screenshot/RainbowStream.png)
-![rainbowstreamIOT](./screenshot/RainbowStreamIOT.png)
-
+Screenshot: (Click to see)
+![rainbowstream](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png)
 
 ## Install
 You will need Python 2.7+ and pip.
@@ -38,14 +36,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,17 +56,23 @@ 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.
 
-Available commands are listed in [Read The Docs](http://rainbowstream.readthedocs.org/en/latest/) .
+## Available commands
+
+Available commands are listed in [ReadTheDocs documents](http://rainbowstream.readthedocs.org/en/latest/) .
 
 ## Theme customization
-Rainbow Stream is shipped with some default themes. 
+Rainbow Stream is shipped with some default themes.
 You can either change theme by `theme` command or create your favorite one.
 
-Theme's screenshot: 
+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)
 
@@ -77,6 +81,25 @@ 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)
 
+## Development
+If you want to build a runnable version yourself, follow these simple steps
+* [Create your own Twitter Application](https://apps.twitter.com/app/new)
+* Get your Twitter application's API key and secret
+* Fork this repo
+* Create a file `consumer.py` in [`rainbowstream`](https://github.com/DTVD/rainbowstream/tree/master/rainbowstream) folder with following content
+```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
+```bash
+# cd to directory which contains setup.py
+pip install -e .
+pip list | grep rainbowstream # confirm installed version
+rainbowstream # local version of rainbowstream
+```
+
 ## Contributing
 I appreciate any help and support. Feel free to
 [fork](https://github.com/DTVD/rainbowstream/fork)