Update README.rst
This commit is contained in:
29
README.rst
29
README.rst
@@ -67,30 +67,13 @@ Controls
|
|||||||
|
|
||||||
Move the cursor using either the arrow keys or *Vim* style movement
|
Move the cursor using either the arrow keys or *Vim* style movement
|
||||||
|
|
||||||
- Press **up** and **down** to scroll through submissions.
|
- Press **up** and **down** to scroll through submissions
|
||||||
- Press **right** to view the selected submission and **left** to return.
|
- Press **right** to view the selected submission and **left** to return
|
||||||
- Press **?** to open the help screen.
|
- 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.
|
See `CONTROLS <https://github.com/michael-lazar/rtv/blob/master/CONTROLS.rst>`_ for the full list of 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/>`_
|
|
||||||
|
|
||||||
========
|
========
|
||||||
Settings
|
Settings
|
||||||
|
|||||||
Reference in New Issue
Block a user