From 73cda0fb5a0c9ec5836faf7ba1f7865080455260 Mon Sep 17 00:00:00 2001 From: Peter Giacomo Lombardo Date: Thu, 27 Jun 2024 14:24:33 +0200 Subject: [PATCH] Update README.md --- README.md | 39 +++++++++++++++++++++++++++------------ 1 file changed, 27 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index bddfad5d..1b378901 100644 --- a/README.md +++ b/README.md @@ -14,23 +14,38 @@ ![Static Badge](https://img.shields.io/badge/.NET%20Core-7-%23512BD4?style=for-the-badge) ![Static Badge](https://img.shields.io/badge/.NET%20Core-8-%23512BD4?style=for-the-badge) - +### 💽 Installation & Compatibility * **Easy-to-Install**: Available as a [Nuget package](https://www.nuget.org/packages/HiveMQtt). -* **Compliant**: Fully compliant with the [MQTT 5.0 specification](https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html). -* **Works with Any MQTT 5.0 Broker**: Built by HiveMQ but not only for HiveMQ. -* **Opensource**: No blackbox code. Only trusted, tested and reviewed opensource code. -* **Easy to Use**: Smart defaults, excellent interfaces and intelligent automation makes implementing a breeze. -* **Fast**: Optimized & benchmarked. See the benchmark results [here](https://github.com/hivemq/hivemq-mqtt-client-dotnet/blob/main/Benchmarks/ClientBenchmarkApp/README.md). -* **Actively Maintained**: Built by the MQTT professionals that built HiveMQ (and do this for a living). -* **Extensively Documented**: What good is it without [excellent documentation](https://hivemq.github.io/hivemq-mqtt-client-dotnet/)? -* **Supported**: Contact us anytime in [this repository](https://github.com/hivemq/hivemq-mqtt-client-dotnet/issues), in the [community forum](https://community.hivemq.com) or [through support](https://www.hivemq.com/support/). +* **Globally Compatible**: Built to be a fully compliant MQTT 5.0 client compatible with all modern MQTT brokers. +* **Multi-Targeted**: Supports .NET 6.0, 7.0 & 8.0 + +### 🚀 Features +* **MQTT 5.0 Support**: Fully compliant with the latest [MQTT 5.0 specification](https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html), ensuring compatibility with modern MQTT brokers. +* **Back Pressure Management**: Automatically manages back pressure to prevent overwhelming the broker (or client), ensuring reliable and efficient communication. +* **Asynchronous Design**: Designed for high-performance and low-latency communication, allowing your application to process multiple messages concurrently. * **Extensive Event System**: Hook into all parts of the client down to the packet level with [built in events](https://hivemq.github.io/hivemq-mqtt-client-dotnet/docs/events). * **Global and Per-Subscription Message Handling**: Use multiple targeted handlers for more targeted and specialized message processing. * **Full Last Will & Testament Support**: Reliable message delivery and notification of client disconnections. -* **Observable**: Configure up to [TRACE level logging](https://hivemq.github.io/hivemq-mqtt-client-dotnet/docs/how-to/debug) for package internals. * **Secure Client Identification**: Full support for [X.509 client certificates](https://hivemq.github.io/hivemq-mqtt-client-dotnet/docs/how-to/client-certificates) and TLS connections. -* **Globally Compatible**: Built to be a fully compliant MQTT 5.0 client compatible with all reputable MQTT brokers. -* **Multi-Targeted**: Supports .NET 6.0, 7.0 & 8.0 +* **Observable**: Configure up to [TRACE level logging](https://hivemq.github.io/hivemq-mqtt-client-dotnet/docs/how-to/debug) for package internals. +* **Fast**: Optimized & benchmarked. See the benchmark results [here](https://github.com/hivemq/hivemq-mqtt-client-dotnet/blob/main/Benchmarks/ClientBenchmarkApp/README.md). + +### 🏝️ Ease of Use +* **Easy to Use**: Smart defaults, excellent interfaces and intelligent automation makes implementing a breeze. +* **Easy Integration**: Simple and intuitive API makes it easy to integrate with your .NET applications. + +### 🛟 Maintenance and Support +* **Actively Maintained**: Built by the MQTT professionals that built HiveMQ (and do this for a living). +* **Supported**: Contact us anytime in [this repository](https://github.com/hivemq/hivemq-mqtt-client-dotnet/issues), in the [community forum](https://community.hivemq.com) or [through support](https://www.hivemq.com/support/). +* **Extensively Documented**: What good is it without [excellent documentation](https://hivemq.github.io/hivemq-mqtt-client-dotnet/)? + +### 🐧 Opensource +* **Opensource**: No blackbox code. Only trusted, tested and reviewed opensource code. + + +**📍 Get Started Today** + +Download the HiveMQ C# MQTT Client for .NET and start building your next-generation IoT, industrial automation, or real-time data streaming application with HiveMQ on your side. _Do you have a success story with this client? [Let us know](). We'd love to feature your story in a blog post or video and you'll get some sweet HiveMQ swag (and publicity) along the way._