X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=5727f2903c9e7dd48d76db2b0ab7a0827b828e31;hp=f2c760da8c413ff081dd53a18fe4b73c9fcd016e;hb=9fa1d26a44f57d4be9cce26e9dd2255156da714a;hpb=4373c17c2eebb276c292b083c4145f57f1e72438 diff --git a/README.rst b/README.rst index f2c760d..5727f29 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,12 @@ Rainbow Stream -------------- +.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat + :target: https://pypi.python.org/pypi/rainbowstream + +.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat + :target: https://pypi.python.org/pypi/rainbowstream + Terminal-based Twitter Client. Realtime tweetstream, compose, search , favorite … and much more fun directly from terminal. @@ -10,11 +16,11 @@ Streaming API`_ and inspired by `EarthQuake`_ Screenshot ---------- -.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamvSS.png +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png :alt: v0.0.1 -.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamvSS(Image).png - :alt: v0.0.2 +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png + :alt: v0.0.3 Install ------- @@ -39,11 +45,12 @@ Just type and see your stream. -In the case you want to see photos directly in terminal, the command is +I shipped a feature which can display **tweet's images directly on terminal**. +You can try it with: .. code:: bash - rainbow -img 1 # Or rainbow --image 1 + rainbow -iot # Or rainbow --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 @@ -54,11 +61,11 @@ The 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 +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 +suggestion. Input history from previous run is available as well. Here is full list of supported command @@ -104,9 +111,15 @@ Here is full list of supported command - ``s #noah`` will search the word *‘noah’*. Result will come back with highlight. -- ``fr`` will list all friend (You are following people). +- ``show image 12`` will show the image in tweet with *[id=12]* in your OS's image viewer. + +- ``ls fl`` will list all your followers (people who are following you). + +- ``ls fr`` will list all your friends (people who you are following). + +- ``fl @dtvd88`` will follow @dtvd88. -- ``fl`` will list all follower. +- ``ufl @dtvd88`` will unfollow @dtvd88. - ``h`` will show the help.