Skip to content

Commit

Permalink
docs: Update Readme to refer to 3.1 main doc page (#642)
Browse files Browse the repository at this point in the history
Signed-off-by: Elizabeth J Lee <[email protected]>
  • Loading branch information
ejlee3 authored Nov 6, 2023
1 parent a20e3f6 commit daf9656
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@
## Overview
MQTT Micro Service - device service for connecting a MQTT topic to EdgeX acting like a device/sensor feed.

## Documentation

For latest documentation please visit https://docs.edgexfoundry.org/latest/microservices/device/services/device-mqtt/Purpose

## Build with NATS Messaging
Currently, the NATS Messaging capability (NATS MessageBus) is opt-in at build time.
This means that the published Docker images do not include the NATS messaging capability.
Expand All @@ -28,9 +32,6 @@ See [Compose Builder](https://github.com/edgexfoundry/edgex-compose/tree/main/co
This component is packaged as docker images.
Please refer to the [Dockerfile](Dockerfile) and [Docker Compose Builder](https://github.com/edgexfoundry/edgex-compose/tree/main/compose-builder) scripts.

## Usage
Users can refer to [this document](https://docs.edgexfoundry.org/2.1/examples/Ch-ExamplesAddingMQTTDevice) to learn how to use this device service.

## Community
- Discussion: https://github.com/orgs/edgexfoundry/discussions
- Mailing lists: https://lists.edgexfoundry.org/mailman/listinfo
Expand Down

0 comments on commit daf9656

Please sign in to comment.