bumped version
[rainbowstream.git] / README.md
index 8638c02..a621318 100644 (file)
--- a/README.md
+++ b/README.md
 ## Rainbow Stream
-Terminal-based Twitter Client with Streaming API support. 
-Realtime tweetstream, compose, search ... and much more fun directly from terminal.
-Only supports Python 2.7 or later.
 
-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)
+[![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)
 
-## Screenshot
-![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png)
+Terminal-based Twitter Client.
+Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
 
-## Install
-**The recommened way:**
-* Clone this repo
-* Create virtualenv (optional but recommended)
-* Install dependencies
-* Install the package itself
+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: (Click to see)
+![rainbowstream](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png)
 
+## Install
+#### The quick way
+You will need Python and pip (2.7.x or 3.x).
 ```bash
-git clone https://github.com/DTVD/rainbowstream.git
-cd rainbowstream
-virtualenv venv # Assume that you have virtualenv installed by "pip install virtualenv"
-source venv/bin/activate
-pip install -e .
+sudo pip install rainbowstream
+# Python 3 users: sudo pip3 install rainbowstream
 ```
-**The quick way:**
-* Install everything over the air
 
+#### The recommended way
+Use [virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/)
 ```bash
-sudo pip install git+https://github.com/DTVD/rainbowstream.git
+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
 ```
-**Note the I only support Python version 2.7+**
+
 
 ## 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
+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
-While the rainbow stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
-Simply hit Enter key and type "h" to view 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
-
-Here is full list of supported command
-
-```bash
-[@dtvd88]home 
-```
-Show your timeline. A number come after will decide number of tweets to print. Ex 'home 10'.
+## Interactive mode
 
-```bash
-[@dtvd88]view @mdo 
-```
-Show @mdo 's timeline.
+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.
 
-```bash
-[@dtvd88]t the rainbow is god's promise to noah
-```
-Tweet exactly 'the rainbow is god's promise to noah'
+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.
 
-```bash
-[@dtvd88]rt 1
-```
-Retweet the tweet with [id=1]. You can see id of each tweet beside the time.
+## Available commands
 
-```bash
-[@dtvd88]rep 1 Really
-```
-Reply 'Really' to the tweet with [id=1].
+Available commands are listed in [ReadTheDocs documents](http://rainbowstream.readthedocs.org/en/latest/) .
 
-```bash
-[@dtvd88]del 1
-```
-Delete thw tweet with [id=1].
+## Theme customization
+Rainbow Stream is shipped with some default themes.
+You can either change theme by `theme` command or create your favorite one.
 
-```bash
-[@dtvd88]s #noah
-```
-Search the word 'noah'. Result will come back with highlight.
+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)
 
-```bash
-[@dtvd88]fr
-```
-List all friend (You are following people).
+For detaile information, see [theme usage and customization](https://github.com/DTVD/rainbowstream/blob/master/theme.md)
 
-```bash
-[@dtvd88]fl
-```
-List all follower.
+## 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)
 
-```bash
-[@dtvd88]h
+## 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
 ```
-SHow the help.
-
+* Use pip to install in local
 ```bash
-[@dtvd88]c
+# 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
 ```
-Clear the screen.
-
 
-```bash
-[@dtvd88]q
-```
-Quit.
+## 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