Update README.rst

This commit is contained in:
Michael Lazar
2016-07-21 02:24:43 -07:00
committed by GitHub
parent 9e6c2b7891
commit 9231e90359

View File

@@ -67,30 +67,13 @@ Controls
Move the cursor using either the arrow keys or *Vim* style movement
- Press **up** and **down** to scroll through submissions.
- Press **right** to view the selected submission and **left** to return.
- Press **?** to open the help screen.
- Press **up** and **down** to scroll through submissions
- Press **right** to view the selected submission and **left** to return
- Press **u** to login using OAuth
- Press **space** to expand/collapse comments
- Press **?** to open the help screen
See `CONTROLS <https://github.com/michael-lazar/rtv/blob/master/CONTROLS.rst>`_ for the complete list of available commands.
--------------
Authentication
--------------
RTV enables you to login to your reddit account in order to perform actions like voting and leaving comments.
The login process uses OAuth [#]_ and follows these steps:
1. Initiate the login by pressing the ``u`` key.
2. Open a new webpage where reddit will ask you to authorize the application.
3. Click **Accept**.
RTV will retrieve an auth token with your information and store it locally in ``{HOME}/.config/rtv/refresh-token``.
You can disable storing the token by setting ``persistent=False`` in the config.
Note that RTV no longer allows you to input your username/password directly. This method of cookie based authentication has been deprecated by reddit [#]_.
.. [#] `<https://github.com/reddit/reddit/wiki/OAuth2>`_
.. [#] `<https://www.reddit.com/r/redditdev/comments/2ujhkr/important_api_licensing_terms_clarified/>`_
See `CONTROLS <https://github.com/michael-lazar/rtv/blob/master/CONTROLS.rst>`_ for the full list of commands.
========
Settings