bumped v0.2.6

[rainbowstream.git] / README.md

diff --git a/README.md b/README.md
index ea375e0544d422aa80bee793ef510af8ae55409e..d5b53effba1c8df9a810a94df7d2f1b4ab25ea1a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -56,7 +56,9 @@ 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.
 
-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.
@@ -79,6 +81,25 @@ 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
+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)