Skip to content

Commit a69e02b

Browse files
committed
Improvements in README
- Fix markdown. - Remove license badge.
1 parent 8b4f256 commit a69e02b

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

README.md

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11

22
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nanoFramework.Aws.IoTCore.Devices&metric=alert_status)](https://sonarcloud.io/dashboard?id=nanoFramework.Aws.IoTCore.Devices)
33
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=nanoFramework.Aws.IoTCore.Devices&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=nanoframework.Aws.IoTCore.Devices)
4-
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
54
[![NuGet](https://img.shields.io/nuget/dt/nanoFramework.Aws.IoTCore.Devices.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.Aws.IoTCore.Devices/)
65
[![#yourfirstpr](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://github.com/nanoframework/Home/blob/main/CONTRIBUTING.md)
76
[![Discord](https://img.shields.io/discord/478725473862549535.svg?logo=discord&logoColor=white&label=Discord&color=7289DA)](https://discord.gg/gCyBu8T)
@@ -122,14 +121,14 @@ if (shadow == null)
122121
Debug.WriteLine($"Shadow ClientToken: {shadow.DeviceId}, #desired: {shadow.status.desired}, #reported: {shadow.status.reported}");
123122
```
124123

125-
Note: it's important to use a `CancellationToken` that be cancelled after a certain amount of time. Otherwise, this will be blocking the thread up to the point the shadow will be received.
124+
Note: it's important to use a `CancellationToken` that be cancelled after a certain amount of time. Otherwise, this will be blocking the thread up to the point the shadow will be received.
126125

127126
Shadows have status properties, reported and desired. They are a hashtable and you can get or try to get any element.
128127

129128
You can report your Shadow as simple as this:
130129

131-
132130
TODO: does not work yet!!!
131+
133132
```csharp
134133
ShadowCollection reported = new ShadowCollection();
135134
reported.Add("firmware", "myNano");
@@ -171,7 +170,6 @@ awsIoT.SendMessage($"{{\"Temperature\":42,\"Pressure\":1024}}");
171170

172171
You can register an event to receive Cloud to device messages:
173172

174-
175173
TODO: check works!!!
176174

177175
```csharp
@@ -204,7 +202,6 @@ void CloudToDeviceMessageEvent(object sender, CloudToDeviceMessageEventArgs e)
204202

205203
Note: the `sender` is a `MqttConnectionClient` class, you can then send a message back with a confirmation or any logic you've put in place.
206204

207-
208205
### Status update event
209206

210207
A status update event is available:
@@ -225,15 +222,13 @@ void StatusUpdatedEvent(object sender, StatusUpdatedEventArgs e)
225222

226223
Note that they are status change based, so once the connect or disconnect event arrives, they'll be replaced by other events as soon as something else happened like receiving a shadow.
227224

225+
## Future work items for discussion
228226

229-
## Future work items for discussion:
230-
231-
* Better documentation about ensuring "persistent" connections (or not) with documentation (including cloud policy doc for support)
232-
* Add some integration tests, including (scripts to auto provision cloud broker (and/or)) manual setup documents to ensure ease of use.
233-
* Partial Greengrass support?!
234-
* Websocket support?!
235-
* fleet provisioning support?!
236-
227+
- Better documentation about ensuring "persistent" connections (or not) with documentation (including cloud policy doc for support)
228+
- Add some integration tests, including (scripts to auto provision cloud broker (and/or)) manual setup documents to ensure ease of use.-
229+
- Partial Greengrass support?!
230+
- Websocket support?!
231+
- fleet provisioning support?!
237232

238233
## Feedback and documentation
239234

0 commit comments

Comments
 (0)