From 3216f3f41a0a2466be30575fdb07ec7bfe9aee78 Mon Sep 17 00:00:00 2001 From: Orakaro Date: Sun, 22 Jun 2014 23:53:51 +0900 Subject: [PATCH 1/1] fix rst file --- README.rst | 69 +++++++++++++++++++++++++++--------------------------- 1 file changed, 34 insertions(+), 35 deletions(-) diff --git a/README.rst b/README.rst index 9603f56..4fe2360 100644 --- a/README.rst +++ b/README.rst @@ -1,17 +1,25 @@ Rainbow Stream -------------- -|Download| |Version| +.. 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. -This package is built on top of `Python Twitter Tool`_ and `Twitter API`_. +This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_. Screenshot ---------- -|rainbowstream| |rainbowstreamIOT| +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png + :alt: rainbowstream + +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png + :alt: rainbowstreamIOT Install ------- @@ -36,8 +44,8 @@ Just type and see your stream. -I shipped a feature which can display **tweet’s images directly on -terminal**. You can try it with: +I shipped a feature which can display **tweet's images directly on terminal**. +You can try it with: .. code:: bash @@ -45,8 +53,7 @@ terminal**. You can try it with: 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 - +number to the terminal, the rainbow will start. The interactive mode ^^^^^^^^^^^^^^^^^^^^ @@ -64,8 +71,8 @@ Here is full list of supported command **Action Commands** - ``trend`` will show global trending topics. ``trend US`` will show - trends in United States while ``trend JP Tokyo`` will show trends in - Tokyo/Japan. + trends in United States while ``trend JP Tokyo`` will show trends + in Tokyo/Japan. - ``home`` will show your timeline. ``home 10`` will print exactly 10 tweets. @@ -73,11 +80,11 @@ Here is full list of supported command - ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print exactly 9 tweets. -- ``mentions`` will show mentions timeline. ``mentions 7`` will show 7 - mention tweets. +- ``mentions`` will show mentions timeline. ``mentions 7`` will show + 7 mention tweets. - ``t the rainbow is god's promise to noah`` will tweet exactly *‘the - rainbow is god’s promise to noah’*. + rainbow is god’s promise to noah’* - ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time. @@ -90,26 +97,24 @@ Here is full list of supported command - ``ufav 12`` will unfavorite tweet with *[id=12]*. -- ``s #noah`` will search the word *‘noah’*. Result will come back with - highlight. +- ``s #noah`` will search the word *‘noah’*. Result will come back + with highlight. - ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88. -- ``show image 12`` will show the image in tweet with *[id=12]* in your - OS’s image viewer. +- ``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 fl`` will list all your followers (people who are following you). - ``ls fr`` will list all your friends (people who you are following). -- ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7 - messages. +- ``inbox`` will show inbox messages. ``inbox 7`` will show newest + 7 message. -- ``sent`` will show sent messages. ``sent 7`` will show newest 7 - messages. +- ``sent`` will show sent messages. ``sent 7`` will show newest + 7 message. -- ``trash 5`` will remove message with *[message\_id=5]* +- ``trash 5`` will remove message with *[message_id=5]*. - ``whois @dtvd88`` will show profile of @dtvd88. @@ -125,15 +130,14 @@ Here is full list of supported command **Stream Commands** -- ``switch public #AKB48`` will switch current stream to public stream - and track keyword ``AKB48`` +- ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48`` - ``switch public #AKB48 -f`` will do exactly as above but will ask you to provide 2 list: ``Only nicks`` decide what nicks will be include only. - ``Ignore nicks``\ decide what nicks will be exclude. + ``Ignore nicks`` decide what nicks will be exclude. - ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and *IGNORE\_LIST*. You can setup 2 list above at ``config.py`` @@ -141,13 +145,13 @@ Here is full list of supported command - ``switch mine`` will switch current stream to personal stream. ``-f`` and ``-d`` will work as well. + For example see the screenshot above. Bug Report ---------- -Please `create an issue`_ or contact me at -[@dtvd88](https://twitter.com/dtvd88) +Please `create an issue`_ or contact me at `@dtvd88`_ License ------- @@ -158,11 +162,6 @@ 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 - -.. |Download| image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat - :target: https://pypi.python.org/pypi/rainbowstream -.. |Version| image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat - :target: https://pypi.python.org/pypi/rainbowstream -.. |rainbowstream| image:: ./screenshot/RainbowStream.png -.. |rainbowstreamIOT| image:: ./screenshot/RainbowStreamIOT.png +.. _@dtvd88: https://twitter.com/dtvd88 -- 2.25.1