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.
-
+#### The quick way
+You will need Python and pip (2.7.x or 3.x).
```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
-sudo pip install virtualenv # skip if you already have virtualenv
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
-#### The stream
+
Just type
```bash
rainbowstream
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.
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)