Update README.md
[rainbowstream.git] / README.md
index da323fe324d6c083899d12dba12238420d626cb5..49b01f8203284e61c9ba383f937c89af4b30b144 100644 (file)
--- a/README.md
+++ b/README.md
@@ -8,9 +8,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).
 
-## Screenshot
-Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s
+## Showcase
+Screencast: 
+https://www.youtube.com/watch?v=tykCvPMJq8s
+<br>
 
+Screenshot:
 ![rainbowstream](./screenshot/RainbowStream.png)
 ![rainbowstreamIOT](./screenshot/RainbowStreamIOT.png)
 
@@ -19,9 +22,18 @@ Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s
 You will need Python 2.7+ and pip.
 
 ```bash
+sudo pip install rainbowstream
+```
+
+or try it with a virtualenv
+```bash
+pip install virtualenv # skip if you already have virtualenv
+virtualenv venv 
+source venv/bin/activate # use the brand new virtualenv.
 pip install rainbowstream
 ```
 
+
 ## Usage
 #### The stream
 Just type
@@ -132,11 +144,26 @@ You can setup 2 list above at `config.py`
 
 * `switch mine` will switch current stream to personal stream. `-f` and `-d` will work as well.
 
+__Smart shell__
+
+* Put anything to terminal, the app will try to eval and display result as a python interactive shell.
+  * `142857*2` or `101**3` like a calculator.
+  * Even `cal` will show the calendar for current month.
+  * Put `order_rainbow('anything')` or `random_rainow('wahahaha')` will make more fun :)
+
 For example see the screenshot above.
 
-## Bug Report
+## 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)
 
+## Contributing
+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.
+
 ## License
 Rainbow Stream are released under an MIT License. See LICENSE.txt for details