README.md
# Crux.Rest
Package providing rest functions and rate limiting for the [Discord API](https://discordapp.com/developers).
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `crux_rest` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:crux_rest, "~> 0.1.0"}
]
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/crux_rest](https://hexdocs.pm/crux_rest).