X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=c463b2dbc3a4f889ea942e60e70279730db2a5b3;hp=cc633747ab095253263237a551a318daaf82fa4b;hb=37ae740ef2ad0b2a7f2af68d9116c1bc268cbe00;hpb=a38a6465afe78ae4694da66744f8dda7d33d9c1d diff --git a/README.rst b/README.rst index cc63374..c463b2d 100644 --- a/README.rst +++ b/README.rst @@ -12,8 +12,11 @@ favorite … and much more fun directly from terminal. This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_. -Screenshot +Showcase ---------- +Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s + +Screenshot: .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png :alt: rainbowstream @@ -28,6 +31,15 @@ You will need Python 2.7+ and pip. .. code:: bash + sudo pip install rainbowstream + +or try with a virtualenv + +.. code:: bash + + sudo pip install virtualenv # skip if you already have virtualenv + virtualenv venv + source venv/bin/activate # use the brand new virtualenv. pip install rainbowstream Usage @@ -96,6 +108,8 @@ Here is full list of supported command: - ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time. +- ``allrt 12 20`` will list 20 newest retweets of the tweet with *[id=12]*. If the number of retweets is not specified, 5 newest retweets will be listed instead. + - ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*. - ``fav 12`` will favorite the tweet with *[id=12]*. @@ -142,14 +156,6 @@ Here is full list of supported command: - ``report @dtvd88`` will report @dtvd88 as a spam account. -**Screening Commands** - -- ``h`` will show the help. - -- ``c`` will clear the screen. - -- ``q`` will quit. - **Switching Stream Commands** - ``switch public #AKB48`` will switch current stream to public stream @@ -168,15 +174,36 @@ Here is full list of supported command: - ``switch mine`` will switch current stream to personal stream. ``-f`` and ``-d`` will work as well. +**Smart shell** + +- Put anything to terminal, the app will try to eval and display result as a python interactive shell. + + + ``142857*2`` or ``101**3`` like a calculator. + + Even ``cal`` will show the calendar for current month. + + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :) + +**Screening Commands** + +- ``h`` will show the help. + +- ``c`` will clear the screen. + +- ``q`` will quit. For example see the screenshot above. -Bug Report ----------- +Bug and feature requests +------------------------ +Found a bug or a feature request ? Please `create an issue`_ or contact me at `@dtvd88`_ +Contributing +------------ +I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_. +You will be listed as contributor. + License ------- @@ -186,6 +213,7 @@ details .. _Python Twitter Tool: http://mike.verdone.ca/twitter/ .. _Twitter API: https://dev.twitter.com/docs/api/1.1 -.. _EarthQuake: https://github.com/jugyo/earthquake .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new .. _@dtvd88: https://twitter.com/dtvd88 +.. _fork: https://github.com/DTVD/rainbowstream/fork +.. _create a pull request: https://github.com/DTVD/rainbowstream/compare/