README.md
# Off Broadway Beanstalkd
![Travis](https://travis-ci.org/nicksanders/off_broadway_beanstalkd.svg?branch=master)
**A beanstalkd connector for [Broadway](https://github.com/plataformatec/broadway).**
Warning: This is Alpha software and subject to breaking changes.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `off_broadway_beanstalkd` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:off_broadway_beanstalkd, "~> 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/off_broadway_beanstalkd](https://hexdocs.pm/off_broadway_beanstalkd).