From 58299828b1ffef9893394aeeaed6210c45ecf82d Mon Sep 17 00:00:00 2001 From: Bo Jeanes Date: Sun, 18 Sep 2022 14:23:45 +1000 Subject: [PATCH] Document Docker builds --- README.md | 7 ++++--- modbus-mqtt/README.md | 24 ++++++++++++++++++++---- 2 files changed, 24 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f0941c3..a62e71c 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,10 @@ View the appropriate READMEs in each package directory for details about each. ## [`modbus-mqtt`](./modbus-mqtt) -![Crates.io](https://img.shields.io/crates/v/modbus-mqtt.svg) -![docs.rs](https://img.shields.io/docsrs/modbus-mqtt) -![Crates.io](https://img.shields.io/crates/l/modbus-mqtt) +[![Docker](https://img.shields.io/docker/v/bjeanes/modbus-mqtt?label=docker)](https://hub.docker.com/r/bjeanes/modbus-mqtt) +[![Crates.io](https://img.shields.io/crates/v/modbus-mqtt.svg)](https://crates.io/crates/modbus-mqtt) +[![docs.rs](https://img.shields.io/docsrs/modbus-mqtt)](https://docs.rs/modbus-mqtt/latest/modbus_mqtt/) +![license](https://img.shields.io/crates/l/modbus-mqtt) ModbusMQTT is a bridge between Modbus devices and MQTT. It aims to allow the operator to generically expose any compatible Modbus device as though its API were MQTT. diff --git a/modbus-mqtt/README.md b/modbus-mqtt/README.md index e4d4e75..85d7997 100644 --- a/modbus-mqtt/README.md +++ b/modbus-mqtt/README.md @@ -1,8 +1,9 @@ # ModbusMQTT -![Crates.io](https://img.shields.io/crates/v/modbus-mqtt.svg) -![docs.rs](https://img.shields.io/docsrs/modbus-mqtt) -![Crates.io](https://img.shields.io/crates/l/modbus-mqtt) +[![Docker](https://img.shields.io/docker/v/bjeanes/modbus-mqtt?label=docker)](https://hub.docker.com/r/bjeanes/modbus-mqtt) +[![Crates.io](https://img.shields.io/crates/v/modbus-mqtt.svg)](https://crates.io/crates/modbus-mqtt) +[![docs.rs](https://img.shields.io/docsrs/modbus-mqtt)](https://docs.rs/modbus-mqtt/latest/modbus_mqtt/) +![license](https://img.shields.io/crates/l/modbus-mqtt) A bridge between Modbus devices and MQTT. @@ -21,11 +22,26 @@ NOTE: For the time being, this does not support MQTTv5. ## Installing +### From Source + For now, `cargo install` is the easiest way to install. Either run it in a checkout for the latest development version, or run `cargo install modbus-mqtt` to install the latest release version. +### Pre-compiled + If you don't want to set up the Rust toolchain, you can likely found built binaries as build artifacts in the [GitHub Actions tab above](https://github.com/bjeanes/modbus-mqtt/actions?query=is%3Asuccess+branch%3Amain+workflow%3ACI). -In the future, there will also be Docker images made available for convenience. +### Docker + +```sh-session +$ docker run -it --rm bjeanes/modbus-mqtt:edge --help +``` + +Tags: + +* `v#`, `v#.#`, `v#.#.#` - semver releases (`major.minor.patch`) +* `latest` - corresponds to most recently semver-tagged build +* `edge` - latest buildable branch from `main`, likely unstable +* `*-alpine` - alpine versions of above ## Running