X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.md;h=69c00bcddaceef2da2dc23636a1bb8f3606896ee;hp=1102f1c2eac6342814f81da9df6470fb60911d4b;hb=06773ffe10d269c9a6d3763faa77a1a10063e0b6;hpb=91476ec37e468301d39182aff48936749158e976 diff --git a/README.md b/README.md index 1102f1c..69c00bc 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,29 @@ ## Rainbow Stream - -A rainbow stream console for Twitter. -Base on Python Twitter Tool +This is a Twitter timeline on the terminal, base on Python Twitter Tool ## Install -With python 2.7+ You can: +*The easy way:* +* Clone this repo +* Install dependencies +* Install the package itself + ```bash -git clone -pip install requirements.txt +git clone https://github.com/DTVD/rainbowstream.git +cd rainbowstream +pip install -r requirements.txt pip install -e . ``` +*The quick way:* +* Install everything over the air + +```bash +pip install -r https://raw.githubusercontent.com/DTVD/rainbowstream/master/requirements.txt +pip install git+https://github.com/DTVD/rainbowstream.git +``` +**Note the I only support Python version 2.7+** ## Usage +Let's see the rainbow ```bash rainbowstream ``` @@ -20,5 +32,4 @@ rainbowstream ## License - Rainbow Stream are released under an MIT License.