Create README.md

README.md

@@ -0,0 +1,44 @@
+# Mosquitto to HiveMQ Migration Tool
+
+MQTT 5.0 and 3.1.1 compatible migration tool to migrate your persistent connections from Mosquitto to the HiveMQ Enterprise Broker.
+
+## Features
+
+- **All MQTT 3.1.1 and MQTT 5.0 features** are supported (except shared subscriptions, which are not directly persisted in Mosquitto)
+- latest Mosquitto support (1.6.7)
+- easy to use
+
+### Prerequisites
+
+The tool was created using Java 11.
+
+### Quickstart
+
+The simplest way to start the migration tool is typing:
+```$ java -jar migration-tool.jar -i <mosquitto.db>```
+See also ``java -jar migration-tool.jar --help``.
+
+A timestamped folder will be created, which contains a handy backup file. You can then import this file via the HiveMQ Control Center under the Admin/Backup section.
+
+### Building from source
+
+To do a clean build, issue the following command:
+
+`$ ./mvn clean package`
+
+This creates the **migration-tool.jar** which can then be executed.
+
+#### Command Attributes
+
+|Attribute                                         |Explanation                                                            |
+|------------------------------------------------|-------------------------------------------------------------------------|
+| ``-i`` | Enter the input Mosquitto database file which is needed for the migration.
+| ``-o`` | Add a path to specify the output folder of the HiveMQ migration Folder.
+| ``-k`` | Keep the XML Files created by the migration tool for further investigation.
+| ``-v`` | Enable verbose mode to get more details during the migration.
+
+See also ``java -jar migration-tool.jar --help``
+
+## License
+
+See [LICENSE](LICENSE)