README.md
# Crux.Gateway
Package providing a flexible gateway connection to the Discord API.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `crux_gateway` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:crux_gateway, "~> 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_gateway](https://hexdocs.pm/crux_gateway).