From 626c066537863d40f32b1a0d9cef9314691e867c Mon Sep 17 00:00:00 2001 From: Dan Anglin Date: Sun, 25 Feb 2024 15:40:54 +0000 Subject: [PATCH] add config section --- README.asciidoc | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.asciidoc b/README.asciidoc index a6e1663..2028cfe 100644 --- a/README.asciidoc +++ b/README.asciidoc @@ -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: