reset PREFIX after switch stream
[rainbowstream.git] / docs / index.rst
index 0c96d2841a7d083ec64e70744c8aee8ad899d2f3..b9dcdb42c5f635034b6121e18285e5266b3fbdb5 100644 (file)
@@ -144,6 +144,8 @@ Here is full list of supported command:
 \r
 -  ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
 \r
+-  ``share 12`` will copy link to tweet with *[id=12]* to your clipboard if you are on a Mac, or display it directly if you are on Linux.\r
+\r
 -  ``del 12`` will delete tweet with *[id=12]*.\r
 \r
 -  ``show image 12`` will show the image in tweet with *[id=12]* in your OS’s image viewer.\r
@@ -218,9 +220,9 @@ Here is full list of supported command:
 \r
    ``Ignore nicks``\ decide what nicks will be exclude.\r
 \r
--  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
+-  ``switch mine`` will switch current stream to personal stream. ``-f`` will work as well.\r
 \r
--  ``switch mine`` will switch current stream to personal stream. ``-f`` and ``-d`` will work as well.\r
+-  ``switch list`` will switch to a Twitter list's stream. You will be asked for list name.\r
 \r
 **Smart shell**\r
 \r
@@ -335,9 +337,9 @@ You also can view or set a new value of every config key by ``config`` command (
 \r
 -  ``LIST_MAX``: default tweets to display on 'list home' command.\r
 \r
--  ``ONLY_LIST``: filter list on 'switch' command.\r
+-  ``ONLY_LIST``: filter list on 'switch' command. Eg: ["@fat","mdo"]\r
 \r
--  ``IGNORE_LIST``: ignore list on 'switch' command.\r
+-  ``IGNORE_LIST``: ignore list on 'switch' command. Eg: ["@fat"]\r
 \r
 -  ``HISTORY_FILENAME``: name of file which stores input history.\r
 \r
@@ -371,8 +373,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
-In every format, you can use unicode characters like ``\u2665``. \r
-Mac users also can use emoji characters as well (Ex: ``::zap::``). \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
 \r
 Development\r
@@ -402,7 +404,6 @@ steps
        source venv/bin/activate\r
        pip install -e .\r
        which rainbowstream # /this-directory/venv/bin/rainbowstream\r
-       pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)\r
        # Remove ~/.rainbow_oauth if exists\r
        rainbowstream # local version of rainbowstream\r
 \r