summaryrefslogtreecommitdiffstats
path: root/mqtt_websockets/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'mqtt_websockets/README.md')
-rw-r--r--mqtt_websockets/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/mqtt_websockets/README.md b/mqtt_websockets/README.md
new file mode 100644
index 00000000..26416b60
--- /dev/null
+++ b/mqtt_websockets/README.md
@@ -0,0 +1,12 @@
+# mqtt_websockets
+
+Library to connect MQTT client over Websockets Secure (WSS).
+Documentation is pending. Best way to figure out how to use the library it to look at `src\test.c`.
+
+## License
+
+The Project is released under GPL v3 license. See [License](LICENSE)
+
+Uses following git submodules:
+- **c-rbuf**: under LGPL 3 by underhood
+- **c_rhash**: GPL 3 by underhood