Allow specifying the location of the twitter oauth and pocket oauth files. This shoul...

[rainbowstream.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index 0fa1319566f10ce6e146e4232930dbdb5af32f54..9e6d69a72a60cc3f993390b8cce609ba6a19def5 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -113,6 +113,16 @@ provided as follows:
 Both ``--proxy-port`` and ``--proxy-type`` can be omitted. In this case default
 proxy port ``8080`` and default proxy type ``SOCKS5`` are used.
 
+If you would like to specify an alternate location for storing the OAuth credential files for both twitter and pocket you can do so with the ``--twitter-auth`` and ``--pocket-auth`` settings. This is also useful if you wish to have multiple accounts for rainbowstream. Specify a location as follows:
+
+.. code:: bash
+
+    rainbowstream --twitter-auth /path/to/twitter_oauth
+    # or using the short form:
+    rainbowstream -ta /path/to/twitter_oauth
+
+If the oauth file doesn't exist at the location you specified then a new one will be created and you'll be required to autenticate with Twitter again.
+
 The interactive mode
 ^^^^^^^^^^^^^^^^^^^^