From 97abb656a663fb45e3e23d601239dfe98c246044 Mon Sep 17 00:00:00 2001 From: Andy Piper Date: Mon, 4 Mar 2013 21:53:25 +0000 Subject: [PATCH] Improved usage information (e.g. for C++ usage) --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 848418b0..5239ba0a 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,17 @@ The Paho C client comprises four shared libraries: Detailed API documentation is available by building the Doxygen docs in the ``doc`` directory. A [snapshot is also available online](http://www.eclipse.org/paho/files/mqttdoc/Cclient/index.html). +Samples are available in the Doxygen docs and also in ``src/samples`` for reference. + +Note that using the C headers from a C++ program requires the following declaration as part of the C++ code: + +``` + extern "C" { + #include "MQTTClient.h" + #include "MQTTClientPersistence.h" + } +``` + ## Runtime tracing A number of environment variables control runtime tracing of the C library.