diff --git a/README.md b/README.md index a9804cb..cbd2ba9 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,14 @@ It can be configured to automatically convert between different payload formats when reading input data for publish and outputting data for subscribe. The supported data formats and the conversion rules are listed under [supported payload formats](#supported-formats) +## Main features: +- support of many payload formats (json, yaml, protobuf, hex, base64, utf-8, raw) +- convert seamlessly between different payload formats (e.g. from json to protobuf or vice versa) +- automatically publish messages using triggers (periodically, messages on topics) +- subscribe to topics and output messages to console or to file +- support of multiple inputs and outputs per topic +- configuration is stored in a file to support complex configuration scenarios and share them + ## How to use 1. Download the latest release for your platform [from the releases](https://github.com/kaans/mqtli/releases/latest). diff --git a/src/bin.rs b/src/bin.rs index 07c8fed..2c2cb25 100644 --- a/src/bin.rs +++ b/src/bin.rs @@ -1,3 +1,14 @@ +//! # MQTli +//! A multi-payload format CLI tool for communication with an MQTT broker. +//! +//! Main features: +//! - support of many payload formats (json, yaml, protobuf, hex, base64, utf-8, raw) +//! - convert seamlessly between different payload formats (e.g. from json to protobuf) +//! - automatically publish messages using triggers (periodically, messages on topics) +//! - subscribe to topics and output messages to console or to file +//! - support of multiple inputs and outputs per topic +//! - configuration is stored in a file to support complex configuration scenarios and share them +//! use std::ops::Deref; use std::sync::Arc;