add list support and seperate help

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index d7ccada3118602af2aacf7ac64223e4f8424b9cc..b29ef69868e5187abd3384aa177a0909e7459c7e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,14 +9,12 @@ 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>
 
-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.
@@ -28,7 +26,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,39 +36,76 @@ 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.
 Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
 
-#### The interactive mode
+## Interactive mode
 
 While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
 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
+
+Available commands are listed in [ReadTheDocs documents](http://rainbowstream.readthedocs.org/en/latest/) .
+
+## 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 themes and color setting, see [config guide](#)
+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)
 
+## 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
+virtualenv venv # Python3 users: use -p to specify python3
+source venv/bin/activate
+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) 
-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.