From b4f740f33809b884db373991bce49671d78372ad Mon Sep 17 00:00:00 2001 From: Christian <6939810+chkr1011@users.noreply.github.com> Date: Wed, 5 Apr 2023 22:12:58 +0200 Subject: [PATCH] Update readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 0aadf450..90c25b1e 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,22 @@ MQTTnet is a high performance .NET library for MQTT based communication. It prov * A custom message interceptor can be added which allows transforming or extending every received application message * Validate subscriptions and deny subscribing of certain topics depending on requesting clients +## Getting Started + +MQTTnet is delivered via NuGet package manager. You can find the packages here: https://www.nuget.org/packages/MQTTnet/ + +Use these command in the Package Manager console to install MQTTnet manually: +``` +Install-Package MQTTnet +``` + +Samples for using MQTTnet are part of this repository. For starters these samples are recommended: + +- [Connect with a broker](https://github.com/dotnet/MQTTnet/blob/master/Samples/Client/Client_Connection_Samples.cs) +- [Subscribing to data](https://github.com/dotnet/MQTTnet/blob/master/Samples/Client/Client_Subscribe_Samples.cs) +- [Publishing data](https://github.com/dotnet/MQTTnet/blob/master/Samples/Client/Client_Publish_Samples.cs) +- [Host own broker](https://github.com/dotnet/MQTTnet/blob/master/Samples/Server/Server_Simple_Samples.cs) + ## Code of Conduct This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.