iv-org-mirror/shard-athena-negotiation
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/shard-athena-negotiation.git synced 2024-08-15 00:53:23 +00:00
Code Issues Projects Releases Packages Wiki Activity

Getting Started section in API docs (#172)

Browse source 
* Shows how to get started with the component either within or outside of the framework itself.
This commit is contained in:
George Dietrich 2022-04-30 13:24:44 -04:00 committed by GitHub
parent 090b83b5f0
commit 42c57abcfa
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
src/athena-negotiation.cr
View file

@ -16,6 +16,22 @@ alias ANG = Athena::Negotiation
# The `Athena::Negotiation` component allows an application to support [content negotiation](https://tools.ietf.org/html/rfc7231#section-5.3).
# The component has no dependencies and is framework agnostic; supporting various negotiators.
#
# ## Getting Started
#
# If using this component within the [Athena Framework][Athena::Framework], it is already installed and required for you.
# Checkout the [manual](/components/negotiation) for some additional information on how to use it within the framework.
#
# If using it outside of the framework, you will first need to add it as a dependency:
#
# ```yaml
# dependencies:
# athena-negotiation:
# github: athena-framework/negotiation
# version: ~> 0.1.0
# ```
#
# Then run `shards install`, being sure to require it via `require "athena-negotiation"`.
#
# ## Usage
#
# The main type of `Athena::Negotiation` is `ANG::AbstractNegotiator` which is used to implement negotiators for each `Accept*` header.