X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=docs%2Findex.rst;h=ef2c8e2356a6cddb825694612f6e56f344562c7b;hp=9dd732e337696fdf94a99b57ed38a1d4b26dae90;hb=1dca9e246f503fc6741d888f6d3ffe3db32b6b3e;hpb=8d2c1db679b49c431980bb3241f5066663175f5b diff --git a/docs/index.rst b/docs/index.rst index 9dd732e..ef2c8e2 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,10 +1,10 @@ Rainbow Stream -------------- -.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat - :target: https://pypi.python.org/pypi/rainbowstream +.. image:: http://img.shields.io/pypi/l/rainbowstream.svg?style=flat-square + :target: https://github.com/DTVD/rainbowstream/blob/master/LICENSE.txt -.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat +.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat-square :target: https://pypi.python.org/pypi/rainbowstream Terminal-based Twitter Client. Realtime tweetstream, compose, search , @@ -132,6 +132,8 @@ Here is full list of supported command: - ``home`` will show your timeline. ``home 10`` will print exactly 10 tweets. +- ``me`` will show your latest tweets. ``me 2`` will show your last 2 tweets. + - ``notification`` will show your notification from the time you started RainbowStream. - ``mentions`` will show mentions timeline. ``mentions 7`` will show 7 mention tweets. @@ -154,7 +156,9 @@ Here is full list of supported command: - ``conversation 12`` will show the chain of replies prior to the tweet with *[id=12]*. -- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*. +- ``rep 12 Really`` will reply *‘Really’* to the owner of the tweet with *[id=12]*. + +- ``repall 12 Really`` will reply *‘Really’* to all people in the tweet with *[id=12]*. - ``fav 12`` will favorite the tweet with *[id=12]*. @@ -168,6 +172,8 @@ Here is full list of supported command: - ``open 12`` will open url in tweet with *[id=12]* in your OS’s default browser. +- ``pt 12`` will add tweet with *[id=12]* in your Pocket list. + **Direct Messages Commands** - ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7 messages. @@ -317,6 +323,8 @@ You also can view or set a new value of every config key by ``config`` command ( - ``IMAGE_ON_TERM``: display tweet's image directly on terminal. +- ``IMAGE_RESIZE_TO_FIT``: display tweet's image fit inside terminal view (width and height). + - ``THEME``: current theme. - ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not. @@ -325,10 +333,10 @@ You also can view or set a new value of every config key by ``config`` command ( - ``PREFIX``: display formated string of prompt. - + ``#me``: Your username with '@' - + ``#place``: Current list name or public for public stream - + ``#owner``: Owner of the current list - + ``#keyword``: Keyword for a public stream + + ``#me``: Your username with '@', only available in personal stream. + + ``#place``: List name, only available in list stream. + + ``#owner``: Owner of list name, only available in list stream. + + ``#keyword``: Keyword, only available on public stream. - ``SEARCH_TYPE``: search type in 'search' command ('mixed','recent','popular'). @@ -398,6 +406,8 @@ You also can view or set a new value of every config key by ``config`` command ( + ``#recipient_name``: Message's recipient name + ``#recipient_nick``: Message's recipient screen name +- ``POCKET_SUPPORT`` : enable Pocket support. + In every format, you can use unicode characters like ``\u2665``. Mac users also can use emoji characters as well (Ex: ``::zap::``). See `Emoji cheatsheet`_ for details. @@ -419,6 +429,7 @@ steps # Consumer information CONSUMER_KEY = 'APIKey' # Your Twitter application's API key CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret + PCKT_CONSUMER_KEY = 'PocketAPIKey' # Your Pocket application's API key - Use pip to install in local @@ -444,3 +455,4 @@ steps .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10 .. _default config: https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/config .. _Emoji cheatsheet: http://www.emoji-cheat-sheet.com/ +.. _Pocket API: http://getpocket.com/developer/docs/overview