add config section

This commit is contained in:
Dan Anglin 2024-02-25 15:40:54 +00:00
parent 93c30fc438
commit 626c066537
Signed by: dananglin
GPG key ID: 0C1D44CFBEE68638

View file

@ -76,8 +76,36 @@ go install ./cmd/enbas
== Configuration
Enbas uses Go's https://pkg.go.dev/os#UserConfigDir[os.UserConfigDir()] function to determine the
location of your configuration directory.
If you've set the `XDG_CONFIG_HOME` environment variable, the configuration files will be stored in the `$XDG_CONFIG_HOME/enbas` directory.
If this is not set:
- on Linux the configuration directory will be set to `$HOME/.config/enbas`.
- on Darwin (MacOS) the configuration directory will be set to `$HOME/Library/Application Support/enbas`.
- on Windows the configuration directory will be set within the `%AppData%` directory.
If (for whatever reason) any of the above cannot be determined, the configuration directory will be set to
the current working directory.
== Usage
=== Check the build information
=== Check out the help documentation
=== Log into your GoToSocial account
=== View your account information
=== View a remote account
=== View your timeline
=== View a status
== Inspirations
This project was inspired from the following projects: