fix help
[rainbowstream.git] / README.rst
index 738c1f98a88ef9378946bfe75911fdb8f4bbf09b..1daff3f5971909c51802785067e7abeae27127d6 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
@@ -63,30 +69,20 @@ suggestion. Input history from previous run is available as well.
 \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
+**Action Commands**\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
-   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
@@ -105,8 +101,24 @@ Here is full list of supported command
 -  ``s #noah`` will search the word *‘noah’*. Result will come back\r
    with highlight.\r
 \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
 -  ``ufl @dtvd88`` will unfollow @dtvd88.\r
@@ -117,6 +129,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