Skip to content

Commit

Permalink
chore: add main features to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kaans committed Dec 13, 2024
1 parent d3f66a7 commit 6cea95f
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
11 changes: 11 additions & 0 deletions src/bin.rs
Original file line number Diff line number Diff line change
@@ -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;

Expand Down

0 comments on commit 6cea95f

Please sign in to comment.