Update README.rst
[rainbowstream.git] / README.rst
index 49a7c956b6ae9f6af36b60c13374358ba0b5e1e2..9a774bb7b90d6c48dbf7af34ae4aef2c72110bb2 100644 (file)
@@ -10,17 +10,16 @@ Rainbow Stream
 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 build on the top of `Python Twitter Tool`_ and `Twitter API`_.\r
 \r
 Screenshot\r
 ----------\r
 \r
 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
-   :alt: v0.0.1\r
+   :alt: rainbowstream\r
 \r
 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
-   :alt: v0.0.3\r
+   :alt: rainbowstreamIOT\r
 \r
 Install\r
 -------\r
@@ -69,24 +68,11 @@ suggestion. Input history from previous run is available as well.
 \r
 Here is full list of supported command\r
 \r
-**Stream Command**\r
+**Action Commands**\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
-\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\r
+   in Tokyo/Japan.\r
 \r
 -  ``home`` will show your timeline. ``home 10`` will print exactly 10\r
    tweets.\r
@@ -142,6 +128,24 @@ Here is full list of supported command
 \r
 -  ``q`` will quit.\r
 \r
+**Stream Commands**\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
+\r
+\r
 For example see the screenshot above.\r
 \r
 Bug Report\r
@@ -157,7 +161,7 @@ details
 \r
 \r
 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
-.. _Twitter Streaming API: https://dev.twitter.com/docs/api/streaming\r
+.. _Twitter API: https://dev.twitter.com/docs/api/1.1\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