Skip to content

Commit

Permalink
Getting Started section in API docs (#172)
Browse files Browse the repository at this point in the history
* Shows how to get started with the component either within or outside of the framework itself.
  • Loading branch information
Blacksmoke16 authored Apr 30, 2022
1 parent 002c3ef commit d978125
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions src/athena-console.cr
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down

0 comments on commit d978125

Please sign in to comment.