RGB not bold

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index 97b751de9198b086fa41968212739c9a9aed2cc9..565558cf7b28cb95a06fdd2feca75e50639fcdc2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -22,9 +22,18 @@ Screenshot:
 You will need Python 2.7+ and pip.
 
 ```bash
+sudo pip install rainbowstream
+```
+
+or try with a virtualenv
+```bash
+sudo 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
@@ -69,6 +78,9 @@ __Tweet Commands__
 * `t the rainbow is god's promise to noah` will tweet exactly *'the rainbow is god's promise to noah'*.
 
 * `rt 12` will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
+ 
+* `allrt 12 20` will list 20 newest retweets of the tweet with *[id=12]*. 
+If the number of retweets is not specified, 5 newest retweets will be listed instead.
 
 * `rep 12 Really` will reply *'Really'* to the tweet with *[id=12]*.
 
@@ -112,14 +124,6 @@ __Friends and followers Commands__
 
 * `report @dtvd88` will report @dtvd88 as a spam account.
 
-__Screening Commands__
-
-* `h` will show the help.
-
-* `c` will clear the screen.
-
-* `q` will quit.
-
 __Switching Stream Commands__
 
 * `switch public #AKB48` will switch current stream to public stream and track keyword `AKB48`
@@ -135,11 +139,34 @@ 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_rainbow('wahahaha')` will make more fun :)
+
+__Screening Commands__
+
+* `h` will show the help.
+
+* `c` will clear the screen.
+
+* `q` will quit.
+
 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