From d9781256e600ba9e54bf063f250825dfcd02e15e Mon Sep 17 00:00:00 2001
From: George Dietrich <george@dietrich.app>
Date: Sat, 30 Apr 2022 13:24:44 -0400
Subject: [PATCH] `Getting Started` section in API docs (#172)

* Shows how to get started with the component either within or outside of the framework itself.
---
 src/athena-console.cr | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/src/athena-console.cr b/src/athena-console.cr
index 9afd5d2..1ff2cfa 100644
--- a/src/athena-console.cr
+++ b/src/athena-console.cr
@@ -70,6 +70,22 @@ alias ACON = Athena::Console
 #   ACON::Command::Status::SUCCESS
 # end
 # ```
+#
+# ## Getting Started
+#
+# If using this component outside of the [Athena Framework][Athena::Framework], you will first need to add it as a dependency:
+#
+# ```yaml
+# dependencies:
+#   athena-console:
+#     github: athena-framework/console
+#     version: ~> 0.1.0
+# ```
+#
+# Then run `shards install`.
+#
+# From here you can then setup your entry point file talked about earlier, being sure to require the component via `require "athena-console"`.
+# Finally, create/require your `ACON::Command`s, and customize the `ACON::Application` as needed.
 module Athena::Console
   VERSION = "0.1.1"