diff --git a/README.asciidoc b/README.asciidoc index 2028cfe..ffd91d0 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -94,10 +94,74 @@ the current working directory. === Check the build information +You can view the application's version and build information using the `--version` flag. +The build information is correctly displayed if you've downloaded the binary from Codeberg or GitHub, +or if you've built it with Mage. + +[source,console] +---- +$ enbas version --full +Enbas + Version: v0.0.0-13-g26a909d + Git commit: 26a909d + Go version: go1.22.0 + Build date: 2024-02-25T15:22:55Z +---- + === Check out the help documentation +You can view the help documentation with the `--help` flag. +You can also use this flag to view the help documentation for any of the commands. + +[source,console] +---- +$ enbas --help +SUMMARY: + enbas - A GoToSocial client for the terminal. + +VERSION: + v0.0.0-13-g26a909d + +USAGE: + enbas [flags] + enbas [command] + +COMMANDS: + login login to an account on GoToSocial + show print details about a specified resource + switch switch to an account + version print the application's version and build information + +FLAGS: + --help + print the help message + +Use "enbas [command] --help" for more information about a command. +---- + === Log into your GoToSocial account +Use the `login` command to log into your GoToSocial account with Enbas. + +[source,console] +---- +enbas login --instance gotosocial.example.local +---- + +The login flow uses Oauth2 authentication and requires your interaction to complete the process. +The process uses the following steps: + +1. The application will register itself and the GTS server will create a new client ID and secret that it needs for authentication. + +2. The application will then generate a link to the consent form for you to access in your browser. +If you're on Linux the link will open in a new browser. +If you're using a different OS or the browser tab doesn't open you can manually open the link in a new browser tab. + +- Once you've signed in GTS will ask you to confirm that you want to create an out of band token for Enbas. Once you've clicked accept a token will be printed for you. Copy this token and return to your terminal. + +- Paste the token into the prompt and press ENTER. Enbas will then exchange the token for and access token which will be used for authentication on your behalf. Enbas will then verify the access token and confirm that you have successfully logged into your account. + + === View your account information === View a remote account