README.md

CloudMQTT Client

This is a simple client to interact with the CloudMQTT management HTTP API.

Quickstart

Add the CloudMQTT.Client package to your project:

dotnet add package CloudMQTT.Client

Then use it to do a thing:

var client = CloudMqttApi.GetInstance("username", "password");
var users = await client.GetUsers(); // Gets a list of MQTT users for the instance

Building

Ensure you have installed .NET Core

To build a local/development copy, run the following:

dotnet restore
dotnet build

To run the tests, you'll need a CloudMQTT instance's username and password. If you don't have an instance, you can sign up for free. Note, the username and password are usually randomly-generated. (i.e., not the same as the credentials you log in to the CloudMQTT site with.)

CLOUDMQTT_USER=ajeamalr CLOUDMQTT_PASSWORD=uwjamd3k_uma dotnet test

Code of Conduct

We are committed to fostering an open and welcoming environment. Please read our code of conduct before participating in or contributing to this project.

Contributing

We welcome contributions and collaboration on this project. Please read our contributor's guide to understand how best to work with us.

License and Authors

Daniel James

This software is made available by Daniel James under the MIT license.