From cf4987d601a4ccfedbf10f05f25a9365fc46f9b9 Mon Sep 17 00:00:00 2001 From: MarkEEaton Date: Tue, 14 Aug 2018 13:04:21 -0400 Subject: [PATCH] Revise README.rst for clarity --- README.rst | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 97919e0..779af96 100644 --- a/README.rst +++ b/README.rst @@ -1,20 +1,23 @@ Mastodon.py =========== +Register your app! This only needs to be done once. + .. code-block:: python from mastodon import Mastodon - # Register app - only once! - ''' Mastodon.create_app( 'pytooterapp', api_base_url = 'https://mastodon.social', to_file = 'pytooter_clientcred.secret' ) - ''' - # Log in - either every time, or use persisted - ''' +Then login. This can be done every time, or use persisted. + +.. code-block:: python + + from mastodon import Mastodon + mastodon = Mastodon( client_id = 'pytooter_clientcred.secret', api_base_url = 'https://mastodon.social' @@ -24,9 +27,13 @@ Mastodon.py 'incrediblygoodpassword', to_file = 'pytooter_usercred.secret' ) - ''' - # Create actual API instance +To post, create an actual API instance. + +.. code-block:: python + + from mastodon import Mastodon + mastodon = Mastodon( access_token = 'pytooter_usercred.secret', api_base_url = 'https://mastodon.social'