Add Pocket support

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 76167ed8051e228907120de6ed6ab3954095d79d..6e85da0f033b8f817d9c7694106c2fa85d39c03c 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,10 +1,10 @@
 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
+.. image:: http://img.shields.io/pypi/l/rainbowstream.svg?style=flat-square\r
+   :target: https://github.com/DTVD/rainbowstream/blob/master/LICENSE.txt\r
 \r
-.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r
+.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat-square\r
    :target: https://pypi.python.org/pypi/rainbowstream\r
 \r
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
@@ -13,6 +13,10 @@ favorite … and much more fun directly from terminal.
 This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,\r
 can run on Python 2.7.x and 3.x .\r
 \r
+Home page : http://www.rainbowstream.org/\r
+\r
+Source code : https://github.com/DTVD/rainbowstream\r
+\r
 Install\r
 -------\r
 \r
@@ -150,7 +154,9 @@ Here is full list of supported command:
 \r
 -  ``conversation 12`` will show the chain of replies prior to the tweet with *[id=12]*.\r
 \r
--  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
+-  ``rep 12 Really`` will reply *‘Really’* to the owner of the tweet with *[id=12]*.\r
+\r
+-  ``repall 12 Really`` will reply *‘Really’* to all people in the tweet with *[id=12]*.\r
 \r
 -  ``fav 12`` will favorite the tweet with *[id=12]*.\r
 \r
@@ -164,6 +170,8 @@ Here is full list of supported command:
 \r
 -  ``open 12`` will open url in tweet with *[id=12]* in your OS’s default browser.\r
 \r
+-  ``pt 12`` will add tweet with *[id=12]* in your Pocket list.\r
+\r
 **Direct Messages Commands**\r
 \r
 -  ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7 messages.\r
@@ -319,7 +327,12 @@ You also can view or set a new value of every config key by ``config`` command (
 \r
 -  ``HIDE_PROMPT``: hide prompt after receiving a tweet or not.\r
 \r
--  ``PREFIX``: display string of prompt.\r
+-  ``PREFIX``: display formated string of prompt.\r
+\r
+    + ``#me``: Your username with '@', only available in personal stream.\r
+    + ``#place``: List name, only available in list stream.\r
+    + ``#owner``: Owner of list name, only available in list stream.\r
+    + ``#keyword``: Keyword, only available on public stream.\r
 \r
 -  ``SEARCH_TYPE``: search type in 'search' command ('mixed','recent','popular').\r
 \r
@@ -389,6 +402,8 @@ You also can view or set a new value of every config key by ``config`` command (
     + ``#recipient_name``: Message's recipient name\r
     + ``#recipient_nick``: Message's recipient screen name\r
 \r
+- ``POCKET_SUPPORT`` : enable Pocket support.\r
+\r
 In every format, you can use unicode characters like ``\u2665``.\r
 Mac users also can use emoji characters as well (Ex: ``::zap::``).\r
 See `Emoji cheatsheet`_ for details.\r
@@ -410,6 +425,7 @@ steps
        # Consumer information\r
        CONSUMER_KEY = 'APIKey' # Your Twitter application's API key\r
        CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret\r
+       PCKT_CONSUMER_KEY = 'PocketAPIKey' # Your Pocket application's API key\r
 \r
 -  Use pip to install in local\r
 \r
@@ -435,3 +451,4 @@ steps
 .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r
 .. _default config: https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/config\r
 .. _Emoji cheatsheet: http://www.emoji-cheat-sheet.com/\r
+.. _Pocket API: http://getpocket.com/developer/docs/overview\r