Update README.rst
[rainbowstream.git] / README.rst
index 59d48b5..49a7c95 100644 (file)
@@ -1,6 +1,12 @@
 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
+\r
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
 favorite … and much more fun directly from terminal.\r
 \r
@@ -10,9 +16,11 @@ Streaming API`_ and inspired by `EarthQuake`_
 Screenshot\r
 ----------\r
 \r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamvSS.png\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
 \r
 Install\r
 -------\r
@@ -37,6 +45,13 @@ Just type
 \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
+\r
+.. code:: bash\r
+\r
+    rainbow -iot # Or rainbow --image-on-term\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
@@ -46,15 +61,15 @@ The interactive mode
 \r
 While your personal stream is continued, you are also ready to tweet,\r
 search, reply, retweet… directly from console. Simply type “h” and hit\r
-the Enter key to see the help\r
+the Enter key to see the help.\r
 \r
 Input is in interactive mode. It means that you can use arrow key to\r
 move up and down history, tab-autocomplete or 2 tab to view available\r
-suggestion\r
+suggestion. Input history from previous run is available as well.\r
 \r
 Here is full list of supported command\r
 \r
-**Stream Command** ** \r
+**Stream Command**\r
 \r
 -  ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``\r
 \r
@@ -74,10 +89,13 @@ Here is full list of supported command
 **Action Command**\r
 \r
 -  ``home`` will show your timeline. ``home 10`` will print exactly 10\r
-   tweet.\r
+   tweets.\r
 \r
 -  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
-   exactly 9 tweet.\r
+   exactly 9 tweets.\r
+\r
+-  ``mentions`` will show mentions timeline. ``mentions 7`` will show\r
+   7 mention tweets.\r
 \r
 -  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
    rainbow is god’s promise to noah’*\r
@@ -96,9 +114,27 @@ Here is full list of supported command
 -  ``s #noah`` will search the word *‘noah’*. Result will come back\r
    with highlight.\r
 \r
--  ``fr`` will list all friend (You are following people).\r
+-  ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
+\r
+-  ``show image 12`` will show the image in tweet with *[id=12]* in your OS's image viewer.\r
+\r
+-  ``ls fl`` will list all your followers (people who are following you).\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
+\r
+-  ``sent`` will show sent messages. ``sent 7`` will show newest\r
+   7 message.\r
+\r
+-  ``trash 5`` will remove message with *[message_id=5]*.\r
+\r
+-  ``whois @dtvd88`` will show profile of @dtvd88.\r
+\r
+-  ``fl @dtvd88`` will follow @dtvd88.\r
 \r
--  ``fl`` will list all follower.\r
+-  ``ufl @dtvd88`` will unfollow @dtvd88.\r
 \r
 -  ``h`` will show the help.\r
 \r
@@ -111,8 +147,7 @@ For example see the screenshot above.
 Bug Report\r
 ----------\r
 \r
-Please `create an issue`_ or contact me at\r
-[@dtvd88](https://twitter.com/dtvd88)\r
+Please `create an issue`_ or contact me at `@dtvd88`_\r
 \r
 License\r
 -------\r
@@ -125,3 +160,4 @@ details
 .. _Twitter Streaming API: https://dev.twitter.com/docs/api/streaming\r
 .. _EarthQuake: https://github.com/jugyo/earthquake\r
 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
+.. _@dtvd88: https://twitter.com/dtvd88\r