README.md

# OffBroadway.MQTT

A MQTT connector for [Broadway](https://github.com/plataformatec/broadway).

Documentation can be found at [https://hexdocs.pm/off_broadway_mqtt](https://hexdocs.pm/off_broadway_mqtt).

This project provides:

  * `OffBroadway.MQTT.Producer` - A GenStage producer that continuously receives messages from a MQTT topic.
  * `OffBroadway.MQTT.Client` - Default

## Installation

Add `:off_broadway_mqtt` to the list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:broadway_mqtt, "~> 0.1.0"}
  ]
end
```

Add ':off_broadway_mqtt' to the list of applications in your `mix.exs` file

## Usage

Configure Broadway with one or more producers using `OffBroadway.MQTT.Producer`:

```elixir
Broadway.start_link(MyBroadway,
  name: MyBroadway,
  producers: [
    default: [
      module: {OffBroadway.MQTT.Producer, topic: "my/topic"}
    ]
  ]
)
```

## License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.