ss
[rainbowstream.git] / README.rst
index f2c760da8c413ff081dd53a18fe4b73c9fcd016e..5727f2903c9e7dd48d76db2b0ab7a0827b828e31 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,11 +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/RainbowStreamvSS(Image).png\r
-   :alt: v0.0.2\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
+   :alt: v0.0.3\r
 \r
 Install\r
 -------\r
@@ -39,11 +45,12 @@ Just type
 \r
 and see your stream.\r
 \r
-In the case you want to see photos directly in terminal, the command is \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 -img 1 # Or rainbow --image 1\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
@@ -54,11 +61,11 @@ 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
@@ -104,9 +111,15 @@ 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
+-  ``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
+-  ``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