From e555d512e7e505878fe8206a2c48555892f4cebf Mon Sep 17 00:00:00 2001 From: michael-lazar Date: Thu, 5 Mar 2015 23:37:08 -0800 Subject: [PATCH] Added configuration section to readme. --- README.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.rst b/README.rst index d0db15a..d22d4b1 100644 --- a/README.rst +++ b/README.rst @@ -62,3 +62,22 @@ In submission mode you can view the self text for a submission and browse commen :``Right`` or ``Enter``: Toggle the currently selected comment between hidden and visible. Alternatively, load additional comments identified by *[+] more comments*. :``Left``: Exit the submission page and return to the subreddit. + +------------- +Configuration +------------- + +RTV will read a configuration dotfile located at **~/.rtv**. +This can be used to avoid having to re-enter login credentials every time the program is launched. +Each line in the file will replace the corresponding default argument in the launch script. + +Example config file (**~/.rtv**): + +:: + + [rtv] + username=MyUsername + password=MySecretPassword + + # Default subreddit + subreddit=CollegeBasketball