shard-athena-negotiation/README.md

37 lines
1.3 KiB
Markdown
Raw Normal View History

2020-12-24 05:48:48 +00:00
# Negotiation
2020-12-22 04:21:53 +00:00
2020-12-24 05:48:48 +00:00
[![CI](https://github.com/athena-framework/negotiation/workflows/CI/badge.svg)](https://github.com/athena-framework/negotiation/actions?query=workflow%3ACI)
[![Latest release](https://img.shields.io/github/release/athena-framework/negotiation.svg)](https://github.com/athena-framework/negotiation/releases)
2020-12-22 04:21:53 +00:00
2020-12-24 05:48:48 +00:00
Framework agnostic [content negotiation](https://tools.ietf.org/html/rfc7231#section-5.3) library based on [willdurand/Negotiation](https://github.com/willdurand/Negotiation).
2020-12-22 04:21:53 +00:00
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
2020-12-24 05:48:48 +00:00
athena-negotiation:
github: athena-framework/negotiation
version: ~> 0.1.0
2020-12-22 04:21:53 +00:00
```
2. Run `shards install`
## Documentation
2021-01-30 03:34:18 +00:00
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).
2020-12-22 04:21:53 +00:00
## Contributing
2020-12-24 05:48:48 +00:00
1. Fork it (https://github.com/athena-framework/negotiation/fork)
2020-12-22 04:21:53 +00:00
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
2020-12-24 05:48:48 +00:00
- [George Dietrich](https://github.com/blacksmoke16) - creator and maintainer