README.md

# BrotoriftBot

**TODO: Add description**

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `brotorift_bot` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:brotorift_bot, "~> 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/brotorift_bot](https://hexdocs.pm/brotorift_bot).

## Config File Sample

```
# config.exs

use Mix.Config

config :brotorift_bot,
  client: PingPongServer.Client,
  bots: [
    {&PingPongServer.Bots.bot1/1, 3}
  ],
  host: {127, 0, 0, 1},
  port: 12345,
  data_head: 123456,
  heartbeat_interval: 3000

```