From: Orakaro Date: Mon, 5 May 2014 12:55:34 +0000 (+0900) Subject: Update README.md X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=f5dcec852475f6d80cfcd9a0d232aa129308815a;p=rainbowstream.git Update README.md --- diff --git a/README.md b/README.md index 69c00bc..fd3ea3f 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,21 @@ ## Rainbow Stream -This is a Twitter timeline on the terminal, base on Python Twitter Tool +This is a Twitter timeline on the terminal, build on the top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter Streaming API](https://dev.twitter.com/docs/api/streaming) + +## Screenshot +![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png) ## Install *The easy way:* * Clone this repo +* Create virtualenv (optional but recommended) * Install dependencies * Install the package itself ```bash git clone https://github.com/DTVD/rainbowstream.git cd rainbowstream +virtualenv venv +source venv/bin/activate pip install -r requirements.txt pip install -e . ``` @@ -28,8 +34,28 @@ Let's see the rainbow rainbowstream ``` -## Screenshot +## License +Rainbow Stream are released under an MIT License. See below for details +Copyright (c) 2014 Vu Nhat Minh -## License -Rainbow Stream are released under an MIT License. +Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the "Software"), to deal in the Software without +restriction, including without limitation the rights to use, +copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the +Software is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES +OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT +HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING +FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE.