From: Roger Light <roger@atchoo.org>
Date: Tue, 22 Apr 2014 11:51:17 +0000 (+0100)
Subject: Convert README to reStructuredText for PyPi.
X-Git-Tag: v0.9~10
X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=2673e343a36abc9aef5a7f99590a365401c78c8a;p=packages%2Fp%2Fpaho-mqtt.git

Convert README to reStructuredText for PyPi.

Change-Id: I060fa15a7afb6b7bc97e067dffcf7ea9c13ab923
---

diff --git a/README.md b/README.md
deleted file mode 100644
index c6d3269..0000000
--- a/README.md
+++ /dev/null
@@ -1,24 +0,0 @@
-# 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/).
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..aae0b21
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,30 @@
+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.
+
+Paho is an `Eclipse Foundation <https://www.eclipse.org/org/foundation/>`_ project currently in the `incubation phase <http://www.eclipse.org/projects/what-is-incubation.php>`_.
+
+Usage and API
+*************
+
+Detailed API documentation is available through **pydoc**.
+
+Samples are available in the **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/>`_.
+