rst

[rainbowstream.git] / README.rst

diff --git a/README.rst b/README.rst
index a6343400d603223d0774d5f4be62543179fa6485..9603f56c386d85265adc909df186738528fde1f7 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,26 +1,17 @@
 Rainbow Stream\r
 --------------\r
 \r
 Rainbow Stream\r
 --------------\r
 \r

-.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r
-   :target: https://pypi.python.org/pypi/rainbowstream\r
-\r
-.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r
-   :target: https://pypi.python.org/pypi/rainbowstream\r
+|Download| |Version|\r

 \r
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
 favorite … and much more fun directly from terminal.\r
 \r
 \r
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
 favorite … and much more fun directly from terminal.\r
 \r

-This package build on the top of `Python Twitter Tool`_ and `Twitter\r
-Streaming API`_ and inspired by `EarthQuake`_\r
+This package is built on top of `Python Twitter Tool`_ and `Twitter API`_.\r

 \r
 Screenshot\r
 ----------\r
 \r
 \r
 Screenshot\r
 ----------\r
 \r

-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
-   :alt: v0.0.1\r
-\r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
-   :alt: v0.0.3\r
+|rainbowstream| |rainbowstreamIOT|\r

 \r
 Install\r
 -------\r
 \r
 Install\r
 -------\r


@@ -45,8 +36,8 @@ Just type
 \r
 and see your stream.\r
 \r
 \r
 and see your stream.\r
 \r

-I shipped a feature which can display **tweet's images directly on terminal**.\r
-You can try it with:\r
+I shipped a feature which can display **tweet’s images directly on\r
+terminal**. You can try it with:\r

 \r
 .. code:: bash\r
 \r
 \r
 .. code:: bash\r
 \r


@@ -54,7 +45,8 @@ You can try it with:
 \r
 In the first time you will be asked for authorization of Rainbow Stream\r
 app at Twitter. Just click the “Authorize access” button and paste PIN\r
 \r
 In the first time you will be asked for authorization of Rainbow Stream\r
 app at Twitter. Just click the “Authorize access” button and paste PIN\r

-number to the terminal, the rainbow will start.\r
+number to the terminal, the rainbow will start\r
+\r

 \r
 The interactive mode\r
 ^^^^^^^^^^^^^^^^^^^^\r
 \r
 The interactive mode\r
 ^^^^^^^^^^^^^^^^^^^^\r


@@ -69,24 +61,11 @@ suggestion. Input history from previous run is available as well.
 \r
 Here is full list of supported command\r
 \r
 \r
 Here is full list of supported command\r
 \r

-**Stream Command**\r
-\r
--  ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``\r
-\r
--  ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
-   to provide 2 list:\r
-\r
-   ``Only nicks`` decide what nicks will be include only.\r
-\r
-   ``Ignore nicks`` decide what nicks will be exclude.\r
-\r
--  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
-   *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
-\r
--  ``switch mine`` will switch current stream to personal stream. ``-f``\r
-   and ``-d`` will work as well.\r
+**Action Commands**\r

 \r
 \r

-**Action Command**\r
+-  ``trend`` will show global trending topics. ``trend US`` will show\r
+   trends in United States while ``trend JP Tokyo`` will show trends in\r
+   Tokyo/Japan.\r

 \r
 -  ``home`` will show your timeline. ``home 10`` will print exactly 10\r
    tweets.\r
 \r
 -  ``home`` will show your timeline. ``home 10`` will print exactly 10\r
    tweets.\r


@@ -94,11 +73,11 @@ Here is full list of supported command
 -  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
    exactly 9 tweets.\r
 \r
 -  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
    exactly 9 tweets.\r
 \r

--  ``mentions`` will show mentions timeline. ``mentions 7`` will show\r
-   7 mention tweets.\r
+-  ``mentions`` will show mentions timeline. ``mentions 7`` will show 7\r
+   mention tweets.\r

 \r
 -  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
 \r
 -  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r

-   rainbow is god’s promise to noah’*\r
+   rainbow is god’s promise to noah’*.\r

 \r
 -  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
    each tweet beside the time.\r
 \r
 -  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
    each tweet beside the time.\r


@@ -111,22 +90,26 @@ Here is full list of supported command
 \r
 -  ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
 \r
 \r
 -  ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
 \r

--  ``s #noah`` will search the word *‘noah’*. Result will come back\r
-   with highlight.\r
+-  ``s #noah`` will search the word *‘noah’*. Result will come back with\r
+   highlight.\r

 \r
 \r

--  ``show image 12`` will show the image in tweet with *[id=12]* in your OS's image viewer.\r
+-  ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r

 \r
 \r

--  ``ls fl`` will list all your followers (people who are following you).\r
+-  ``show image 12`` will show the image in tweet with *[id=12]* in your\r
+   OS’s image viewer.\r
+\r
+-  ``ls fl`` will list all your followers (people who are following\r
+   you).\r

 \r
 -  ``ls fr`` will list all your friends (people who you are following).\r
 \r
 \r
 -  ``ls fr`` will list all your friends (people who you are following).\r
 \r

--  ``inbox`` will show inbox messages. ``inbox 7`` will show newest\r
-   7 message.\r
+-  ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
+   messages.\r

 \r
 \r

--  ``sent`` will show sent messages. ``sent 7`` will show newest\r
-   7 message.\r
+-  ``sent`` will show sent messages. ``sent 7`` will show newest 7\r
+   messages.\r

 \r
 \r

--  ``trash 5`` will remove message with *[message_id=5]*.\r
+-  ``trash 5`` will remove message with *[message\_id=5]*\r

 \r
 -  ``whois @dtvd88`` will show profile of @dtvd88.\r
 \r
 \r
 -  ``whois @dtvd88`` will show profile of @dtvd88.\r
 \r


@@ -140,12 +123,31 @@ Here is full list of supported command
 \r
 -  ``q`` will quit.\r
 \r
 \r
 -  ``q`` will quit.\r
 \r

+**Stream Commands**\r
+\r
+-  ``switch public #AKB48`` will switch current stream to public stream\r
+   and track keyword ``AKB48``\r
+\r
+-  ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
+   to provide 2 list:\r
+\r
+   ``Only nicks`` decide what nicks will be include only.\r
+\r
+   ``Ignore nicks``\ decide what nicks will be exclude.\r
+\r
+-  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
+   *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
+\r
+-  ``switch mine`` will switch current stream to personal stream. ``-f``\r
+   and ``-d`` will work as well.\r
+\r

 For example see the screenshot above.\r
 \r
 Bug Report\r
 ----------\r
 \r
 For example see the screenshot above.\r
 \r
 Bug Report\r
 ----------\r
 \r

-Please `create an issue`_ or contact me at `@dtvd88`_\r
+Please `create an issue`_ or contact me at\r
+[@dtvd88](https://twitter.com/dtvd88)\r

 \r
 License\r
 -------\r
 \r
 License\r
 -------\r


@@ -155,7 +157,12 @@ details
 \r
 \r
 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
 \r
 \r
 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r

-.. _Twitter Streaming API: https://dev.twitter.com/docs/api/streaming\r
-.. _EarthQuake: https://github.com/jugyo/earthquake\r
+.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r

 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r

-.. _@dtvd88: https://twitter.com/dtvd88\r
+\r
+.. |Download| image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r
+   :target: https://pypi.python.org/pypi/rainbowstream\r
+.. |Version| image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r
+   :target: https://pypi.python.org/pypi/rainbowstream\r
+.. |rainbowstream| image:: ./screenshot/RainbowStream.png\r
+.. |rainbowstreamIOT| image:: ./screenshot/RainbowStreamIOT.png\r