From 22d09a12c255cc43830f0e211f069df37481ce8c Mon Sep 17 00:00:00 2001 From: Dan Anglin Date: Tue, 27 Feb 2024 08:55:01 +0000 Subject: [PATCH] docs: updated README - Specified that installing with mage has an advantage over go install. - Specified that generated tokens allow admin access if the account is an admin. - Specified that credentials are saved to a file in the config dir. --- README.asciidoc | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.asciidoc b/README.asciidoc index 0b3af06..dbadbff 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -37,7 +37,7 @@ Please go https://go.dev/dl/[here] to download the latest version. ===== Mage (Optional) The project includes mage targets for building and installing the binary. -The main advantage of using mage is that the binary's build information is baked into the binary +The main advantage of using mage over `go install ` is that the build information is baked into the binary during compilation. You can visit the https://magefile.org/[Mage website] for instructions on how to install Mage. ==== Install with mage @@ -146,7 +146,8 @@ Enbas uses the Oauth2 authentication flow to log into your account on GTS. This [WARNING] ==== 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. +tokens, the application will be able to perform any actions within the limitations of of your account +(including admin actions if you are an admin). You can read more about this https://docs.gotosocial.org/en/latest/api/authentication/[here]. ==== @@ -173,9 +174,11 @@ image::assets/images/consent_form.png[A screenshot of the consent form] 5. The `out-of-band` token will be printed for you at this point. Copy it and return to your terminal. -6. Paste the token into the prompt and press ENTER. -Enbas will then exchange the token for an access token which will be used to authentication to the GTS server on your behalf. -Enbas will then verify the access token and confirm that you have successfully logged into your account. +6. Paste the token into the prompt and press `ENTER`. +Enbas will then exchange the token for an access token which will be used to authentication to the +GTS server on your behalf. +Enbas will then verify the access token, save the credentials to a file in your configuration directory, +and confirm that you have successfully logged into your account. + [source,console] ----