]> git.michaelhowe.org Git - packages/p/paho-mqtt.git/commitdiff
Basic readme based on Paho C client.
authorRoger Light <roger@atchoo.org>
Mon, 17 Jun 2013 22:45:08 +0000 (23:45 +0100)
committerRoger Light <roger@atchoo.org>
Mon, 3 Feb 2014 21:16:19 +0000 (21:16 +0000)
README.md [new file with mode: 0644]

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..c6d3269
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Eclipse Paho MQTT Python client
+
+
+This repository contains the source code for the [Eclipse Paho](http://eclipse.org/paho/) MQTT Python client library. 
+
+This code builds libraries which enable applications to connect to an [MQTT](http://mqtt.org/) broker to publish messages, and to subscribe to topics and receive published messages.
+
+## Usage and API
+
+Detailed API documentation is available through ``pydoc``.
+
+Samples are available in ``examples`` directory.
+
+## Reporting bugs
+
+Please report bugs under the "MQTT-Python" Component in [Eclipse Bugzilla](http://bugs.eclipse.org/bugs/) for the Paho Technology project.
+
+## More information
+
+Discussion of the Paho clients takes place on the [Eclipse paho-dev mailing list](https://dev.eclipse.org/mailman/listinfo/paho-dev).
+
+General questions about the MQTT protocol are discussed in the [MQTT Google Group](https://groups.google.com/forum/?fromgroups#!forum/mqtt).
+
+There is much more information available via the [MQTT community site](http://mqtt.org/).