mirror of
https://gitea.invidious.io/iv-org/shard-athena-negotiation.git
synced 2024-08-15 00:53:23 +00:00
3982e1b523
* Revamp CI GHA workflow * Remove CI scripts from components * Normalize READMEs to point back to monorepo
28 lines
1.2 KiB
Markdown
28 lines
1.2 KiB
Markdown
# Negotiation
|
|
|
|
[![CI](https://github.com/athena-framework/athena/workflows/CI/badge.svg)](https://github.com/athena-framework/athena/actions/workflows/ci.yml)
|
|
[![Latest release](https://img.shields.io/github/release/athena-framework/negotiation.svg)](https://github.com/athena-framework/negotiation/releases)
|
|
|
|
Framework agnostic [content negotiation](https://tools.ietf.org/html/rfc7231#section-5.3) library based on [willdurand/Negotiation](https://github.com/willdurand/Negotiation).
|
|
|
|
## Installation
|
|
|
|
1. Add the dependency to your `shard.yml`:
|
|
|
|
```yaml
|
|
dependencies:
|
|
athena-negotiation:
|
|
github: athena-framework/negotiation
|
|
version: ~> 0.1.0
|
|
```
|
|
|
|
2. Run `shards install`
|
|
|
|
## Documentation
|
|
|
|
If using the component on its own, checkout the [API documentation](https://athenaframework.org/Negotiation).
|
|
If using the component as part of Athena, also checkout the [external documentation](https://athenaframework.org/components/negotiation).
|
|
|
|
## Contributing
|
|
|
|
[Report issues](https://github.com/athena-framework/athena/issues) and send [Pull Requests](https://github.com/athena-framework/athena/pulls) in the [main Athena repository](https://github.com/athena-framework/athena).
|