samples 2 docker and README

iotmodels · Sep 16, 2022 · 9c07bdc · 9c07bdc
1 parent f8be19e
commit 9c07bdc
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 1 deletion.
diff --git a/.github/workflows/memmon-docker.yml → .github/workflows/samples2docker.yml b/.github/workflows/memmon-docker.yml → .github/workflows/samples2docker.yml
@@ -5,6 +5,7 @@ on:
     branches: [ "master", "dev" ]
     paths:
       - 'samples/**'
+    workflow_dispatch:
 
 jobs:
   build:

diff --git a/MQTTnet.Extensions.MultiCloud.sln b/MQTTnet.Extensions.MultiCloud.sln
@@ -24,6 +24,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{22965CB2-1
 		docs\feat-matrix.md = docs\feat-matrix.md
 		docs\iotpnp-128.png = docs\iotpnp-128.png
 		README.md = README.md
+		samples\README.md = samples\README.md
 		docs\tmo.gif = docs\tmo.gif
 		docs\X509Certificates.md = docs\X509Certificates.md
 	EndProjectSection
@@ -32,8 +33,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "_actions", "_actions", "{68
 	ProjectSection(SolutionItems) = preProject
 		.github\workflows\cd.yml = .github\workflows\cd.yml
 		.github\workflows\ci.yml = .github\workflows\ci.yml
-		.github\workflows\memmon-docker.yml = .github\workflows\memmon-docker.yml
 		.github\workflows\push2nuget.yml = .github\workflows\push2nuget.yml
+		.github\workflows\samples2docker.yml = .github\workflows\samples2docker.yml
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{F618E3CF-0552-44BD-A92A-A926AF319D00}"

diff --git a/samples/README.md b/samples/README.md
@@ -0,0 +1,25 @@
+# MQTTnet.Exntensions.MultiCloud Samples
+
+This folder contains sample projects with devices that can be connected to multiple MQTT endpoints
+
+>Note: All samples must be run with the `ConnectionStrings__cs` envvar, or as CLI argument `/ConnectionStrings:cs` . There are sample connection strings in the launchSettings.json.template to use as `dotnet run --launch-profile`
+
+## memmon
+
+The legendary Memory Monitor implemented for Broker, IoTHub and AWS.
+
+Docker image available as `ghcr.io/iotmodes/memmon:x64`
+
+## pi-sense-device
+
+Using the sensors available from the PiSenseHat, implementing the model https://iotmodels.github.io/dmr/dtmi/com/example/devicetemplate-1.json
+
+Docker image avaialble as ` ghcr.io/iotmodels/pi-sense-device:x64`
+
+## mqtt-device
+
+Implements a sample `DeviceTemplate` model, targets Hub and Broker
+
+## iothub-sample
+
+Shows how to use the `AzureIoTClient` to connect to Azure IoT Hub and DPS using `HubMqttClient` (untyped APIs)