Add the Labs projects provided in the V10.2.1_191129 zip file.

[freertos] / FreeRTOS-Labs / Demo / FreeRTOS_IoT_Libraries / mqtt / readme.txt

diff --git a/FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/mqtt/readme.txt b/FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/mqtt/readme.txt
new file mode 100644 (file)
index 0000000..7d32bd3
--- /dev/null
+++ b/FreeRTOS-Labs/Demo/FreeRTOS_IoT_Libraries/mqtt/readme.txt
@@ -0,0 +1,26 @@
+See https://freertos.org/mqtt/ for further information.\r
+\r
+Contains projects that demonstrate the IoT MQTT library.\r
+\r
+- Securing MQTT Communication -\r
+Internet of Things use cases require MQTT communications to be secured, but secure\r
+authentication and encryption are not part of the MQTT specification.  It is\r
+therefore common to use MQTT in combination with Transport Layer Security (TLS).\r
+TLS encrypts data sent across a network and enables the data's destination to be\r
+authenticated.  'Server authentication' is when the MQTT client authenticates the\r
+identity of the MQTT broker.  'Mutual authentication' is when the MQTT broker also\r
+authenticates the identity of the MQTT client.\r
+\r
+\r
+- Pre-configured MQTT Example Projects -\r
+The examples contained in subdirectories from here demonstrate the concepts\r
+described above one at a time.  The first example demonstrates plain text\r
+(unencrypted) MQTT communication, the second example builds on the first to\r
+introduce weak server authentication, and the third example builds on the second to\r
+introduce strong mutual authentication.  Note:  It is our recommendation to always\r
+use strong mutual authentication in any Internet of Things (IoT) application.  The\r
+plain text project is only provided to validate MQTT communication can be\r
+established prior to introducing encryption and authentication, and to allow the\r
+MQTT packets to be observed using a network packet sniffer such as Wireshark for\r
+those who wish to do so.  The first two projects are in no way intended to be\r
+examples suitable for production use.\r