diff --git a/README.asciidoc b/README.asciidoc index 8baa020..61737ff 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -141,7 +141,17 @@ Use "enbas [command] --help" for more information about a command. === Log into your GoToSocial account -Enbas uses the Oauth2 authentication flow to log into your account on GTS. This process requires your input to give consent to allow Enbas access to your account. The login flow is completed using the following steps: +Enbas uses the Oauth2 authentication flow to log into your account on GTS. This process requires your input to give consent to allow Enbas access to your account. + +[WARNING] +.Scoped Tokens +==== +As of writing GoToSocial does not currently support scoped authorization tokens so even if we request read-only +tokens, the application will be able to perform all actions within the limit of of your account. +You can read more about this https://docs.gotosocial.org/en/latest/api/authentication/[here]. +==== + +The login flow is completed using the following steps: 1. You start by using the `login` command specifying the instance that you want to log into. + @@ -186,11 +196,28 @@ Successfully logged into bobby@gotosocial-01.social.example === View your account information -=== View a remote account +[source,console] +---- +enbas show --type account --my-account +---- -=== View your timeline +=== View a local or remote account -=== View a status +[source,console] +---- +enbas show --type account --account teddy@gotosocial-01.social.example +---- + +=== View your home timeline + +[source,console] +---- +enbas show --type timeline +---- + +=== View the details of a status + +TODO == Inspirations