From 0509290e15d0dbc85e1287fd294c77f8dfd574f2 Mon Sep 17 00:00:00 2001
From: Dan Anglin <daangling@gmail.com>
Date: Sat, 29 Jun 2024 14:21:57 +0100
Subject: [PATCH] checkpoint: writing getting started guide

---
 README.asciidoc         |  2 +-
 docs/changelog.md       |  0
 docs/cheatsheet.md      |  0
 docs/getting-started.md | 30 ++++++++++++++++++++++++++++++
 docs/install.md         |  6 ++++--
 5 files changed, 35 insertions(+), 3 deletions(-)
 create mode 100644 docs/changelog.md
 create mode 100644 docs/cheatsheet.md
 create mode 100644 docs/getting-started.md

diff --git a/README.asciidoc b/README.asciidoc
index ccbcc07..6f4ad5d 100644
--- a/README.asciidoc
+++ b/README.asciidoc
@@ -134,7 +134,7 @@ enbas show --type status --status-id 01HQE43KT5YEDN4RGMT7BC63PF
 
 == Inspirations
 
-This project was inspired from the following projects:
+This project was inspired by the following projects:
 
 * **madonctl:** https://github.com/McKael/madonctl[A Mastodon CLI client written in Go.]
 * **toot:** https://pypi.org/project/toot/[A Mastodon CLI and TUI written in Python.]
diff --git a/docs/changelog.md b/docs/changelog.md
new file mode 100644
index 0000000..e69de29
diff --git a/docs/cheatsheet.md b/docs/cheatsheet.md
new file mode 100644
index 0000000..e69de29
diff --git a/docs/getting-started.md b/docs/getting-started.md
new file mode 100644
index 0000000..4a026c3
--- /dev/null
+++ b/docs/getting-started.md
@@ -0,0 +1,30 @@
+# Getting Started
+
+## Summary
+
+In this guide we are going to log into an account on a private GoToSocial server.
+Follow along to log into your own account.
+
+## Your configuration directory
+
+Enbas uses Go's [os.UserConfigDir()](https://pkg.go.dev/os#UserConfigDir) function to calculate the location of your configuration directory.
+
+If you've set the `XDG_CONFIG_HOME` environment variable, the configuration directory will be set to `$XDG_CONFIG_HOME/enbas`.
+
+If this is not set, then:
+
+- 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.
+
+Alternatively you can use the `--config-dir` global flag to specify your configuration directory.
+
+## Generate your configuration file
+
+Run `enbas init` to generate your configuration file.
+
+View configuration file. JSON file, mostly blank slate for you to configure to your preferences. Configuration documentation coming soon. For this getting started guide you may want to specify your preferred browser to open the link to your instance's login page. Can leave blank if you prefer to open the link manually.
+
+## Log into your GoToSocial account
+
+## View your account information
diff --git a/docs/install.md b/docs/install.md
index b84fdf4..dc74bdc 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -35,7 +35,7 @@ ENBAS_INSTALL_PREFIX=${HOME}/.local mage install
 
 This will install Enbas to `~/.local/bin/enbas`.
 
-===== Environment variables you can use with Mage
+The table below shows all the environment variables you can use when building with Mage.
 
 | Environment Variable     | Description                                                                  |
 |--------------------------|------------------------------------------------------------------------------|
@@ -53,7 +53,7 @@ cd enbas
 go install ./cmd/enbas
 ```
 
-### Verify the installation
+## Verify the installation
 
 Type `enbas` from your terminal to verify that the installation was successful. You should see the help documentation.
 
@@ -113,3 +113,5 @@ Git commit: c8892a6
 Go version: go1.22.4
 Build date: 2024-06-28T21:57:37Z
 ```
+
+Once you have completed the installation proceed to the [Getting Started guide](./getting-started.md).