list fully supported and autopep8

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index 9e6014e375b9a3d62af08e812afa0af2d001c667..a621318ecbe9084a8447985da3a50e82800cdc22 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,39 +13,40 @@ Screencast:
 https://www.youtube.com/watch?v=tykCvPMJq8s
 <br>
 
 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
 
 ## Install

-You will need Python 2.7+ and pip.
-
+#### The quick way
+You will need Python and pip (2.7.x or 3.x).

 ```bash
 sudo pip install rainbowstream
 ```bash
 sudo pip install rainbowstream

+# Python 3 users: sudo pip3 install rainbowstream

 ```
 
 ```
 

-or try with a virtualenv
+#### The recommended way
+Use [virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/)

 ```bash
 ```bash

-sudo pip install virtualenv # skip if you already have virtualenv

 virtualenv venv
 virtualenv venv

-source venv/bin/activate # use the brand new virtualenv.
+# Python 3 users : use -p to specify your Python 3 localtion as below
+# virtualenv -p /usr/bin/python3 venv
+source venv/bin/activate

 pip install rainbowstream
 ```
 
 
 ## Usage
 pip install rainbowstream
 ```
 
 
 ## Usage

-#### The stream
+

 Just type
 ```bash
 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
 ```
 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.
 ```
 
 In the first time you will be asked for authorization of Rainbow Stream app at Twitter.


@@ -58,15 +59,52 @@ 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.
 
 
 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.

 
 

-For themes and color setting, see [config guide](#).
+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 ?
 Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
 or contact me at [@dtvd88](https://twitter.com/dtvd88)
 
 
 ## Bug and feature requests
 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)
 ## Contributing
 I appreciate any help and support. Feel free to
 [fork](https://github.com/DTVD/rainbowstream/fork)