Diff: README.md

Revision:

0:09ef59d2d0f7

Child:

5:363211a8995f

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Fri Oct 07 17:21:45 2016 +0000
@@ -0,0 +1,13 @@
+# Cayenne MQTT Embedded C/C++
+The Cayenne MQTT Embedded C/C++ Library provides functions to easily connect to the Cayenne IoT project builder.
+
+This library bundles the [Eclipse Paho MQTT C/C++ client](https://github.com/eclipse/paho.mqtt.embedded-c).
+
+## Repository Structure
+
+- **src** - The library source code.
+  - **CayenneUtils** - Common code for creating and parsing Cayenne topics and payloads. This code can be used with any MQTT client.
+  - **CayenneMQTTClient** - Platform independent Cayenne C++ library using the Paho MQTT C++ library. To create platform specific versions of this library networking and timer code for the platform are required.
+  - **MQTTCommon** - Common Paho MQTT C code used by both the C and C++ libraries.
+  - **Platform** - Platform specific networking and timer code, as well as test and example applications.
+    - **mbed** - mbed C++ networking and timer code.