Add Pocket support
[rainbowstream.git] / docs / index.rst
index 5152f4f..6e85da0 100644 (file)
@@ -170,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
@@ -400,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
@@ -421,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
@@ -446,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