bumped version
[rainbowstream.git] / README.md
index 5eae9b0..a621318 100644 (file)
--- a/README.md
+++ b/README.md
-## Rainbow Stream 
+## Rainbow Stream
 
-[![Download](http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream/0.0.3)
-[![Version](http://img.shields.io/pypi/v/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream/0.0.3)
+[![Download](http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
+[![Version](http://img.shields.io/pypi/v/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
 
-
-Terminal-based Twitter Client. 
+Terminal-based Twitter Client.
 Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
 
-This package build on the top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter Streaming API](https://dev.twitter.com/docs/api/streaming) and inspired by [EarthQuake](https://github.com/jugyo/earthquake)
+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).
+
+## Showcase
+Screencast:
+https://www.youtube.com/watch?v=tykCvPMJq8s
+<br>
 
-## Screenshot
-![v0.0.1](./screenshot/RainbowStream.png)
-![v0.0.3](./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
+```
 
+#### The recommended way
+Use [virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/)
 ```bash
+virtualenv venv
+# 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
-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
-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.
 Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
 
-#### The interactive mode
+## Interactive mode
+
 While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
 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.
 
-Here is full list of supported command
-
-__Stream Command__
-* ```switch public #AKB48``` will switch current stream to public stream and track keyword ```AKB48```
-
-* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
-
-    ```Only nicks``` decide what nicks will be include only.
-
-    ```Ignore nicks```decide what nicks will be exclude.
-
-* ```switch public #AKB48 -d ``` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
-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.
-
-__Action Command__
-
-* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
+## Available commands
 
-* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
+Available commands are listed in [ReadTheDocs documents](http://rainbowstream.readthedocs.org/en/latest/) .
 
-* ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*
+## Theme customization
+Rainbow Stream is shipped with some default themes.
+You can either change theme by `theme` command or create your favorite one.
 
-* ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
+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)
 
-* ```fav 12```will favorite the tweet with *[id=12]*.
+For detaile information, see [theme usage and customization](https://github.com/DTVD/rainbowstream/blob/master/theme.md)
 
-* ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.
-
-* ```del 12```will delete tweet with *[id=12]*.
-
-* ```ufav 12```will unfavorite tweet with *[id=12]*.
-
-* ```s #noah```will search the word *'noah'*. Result will come back with highlight.
-
-* ```show image 12``` will show the image in tweet with *[id=12]* in your OS's image viewer.
-
-* ```fl @dtvd88```will follow @dtvd88.
-
-* ```ufl @dtvd88```will unfollow @dtvd88.
-
-* ```h```will show the help.
-
-* ```c```will clear the screen.
-
-* ```q```will quit.
+## 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)
 
-For example see the screenshot above.
+## 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
+```
 
-## Bug Report
-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