Merge pull request #11 from hivemq/release_cleanup

Release cleanup

README.adoc

@@ -1,27 +1,32 @@
-== HiveMQ Heartbeat Extension
+:hivemq-support: http://www.hivemq.com/support/
+:hivemq-extension-download: https://www.hivemq.com/extension/heartbeat-extension/
 
-This extension allows integration with with load balancers and proxies.
+= HiveMQ Heartbeat Extension
 
-=== How it works
+image:https://img.shields.io/badge/Extension_Type-Monitoring-orange?style=for-the-badge[Extension Type]
+image:https://img.shields.io/github/v/release/hivemq/hivemq-heartbeat-extension?style=for-the-badge[GitHub release (latest by date),link=https://github.com/hivemq/hivemq-heartbeat-extension/releases/latest]
+image:https://img.shields.io/github/license/hivemq/hivemq-heartbeat-extension?style=for-the-badge&color=brightgreen[GitHub,link=LICENSE]
+image:https://img.shields.io/github/workflow/status/hivemq/hivemq-heartbeat-extension/CI%20Check/master?style=for-the-badge[GitHub Workflow Status (branch),link=https://github.com/hivemq/hivemq-heartbeat-extension/actions/workflows/check.yml?query=branch%3Amaster]
 
-This extension provides a readiness check via HTTP, which means a service is able to
-detect if a HiveMQ instance is
-offline and the load balancer is thus able to remove the HiveMQ node from the load balancing.
-HiveMQ 4.2.0 is required.
+== Prerequisites
 
-=== Installation
-Unzip the file: `hivemq-heartbeat-extension-<version>-distribution.zip` to the directory: `<HIVEMQ_HOME>/extensions`
-. A configuration file `extension-config.xml` can be found in the `hivemq-heartbeat-extension` folder.
-The properties are preconfigured with standard settings and can be adapted to your needs (The meaning of the fields is explained below).
-. Start HiveMQ.
+* HiveMQ Enterprise Edition (EE) 4.2.0 or later
+* HiveMQ Community Edition (CE) 2020.1 or later
 
+== Purpose
 
+This extension allows integration with load balancers and proxies.
+It provides a readiness check via HTTP, which means a service is able to detect if a HiveMQ instance is offline and the load balancer is thus able to remove the HiveMQ node from the load balancing.
 
-=== Configuration
+== Installation
 
-The Heartbeat extension uses its own configuration file 'extension-config.xml' which must be placed in the extensions folder of HiveMQ.
+* Download the extension from the {hivemq-extension-download}[HiveMQ Marketplace^].
+* Copy the content of the zip file to the `extensions` folder of your HiveMQ nodes.
+* Modify the `extension-config.xml` file for your needs.
+
+== Configuration
 
-==== General Configuration
+The Heartbeat extension uses its own configuration file 'extension-config.xml' which must be placed in the extensions folder of HiveMQ.
 
 |===
 | Config name | Required | Description
@@ -44,8 +49,7 @@ The Heartbeat extension uses its own configuration file 'extension-config.xml' w
 
 IMPORTANT: By Default the Heartbeat is available at http://MY-IP:9090/heartbeat
 
-
-=== Metrics
+== Metrics
 
 This extension exposes a custom metric to HiveMQs holistic metric registry.
 
@@ -55,11 +59,16 @@ This extension exposes a custom metric to HiveMQs holistic metric registry.
 | http-heartbeat-meter | Meter | A meter that shows the frequency of heartbeat requests
 |===
 
+== Need Help?
+
+If you encounter any problems, we are happy to help.
+The best place to get in contact is our {hivemq-support}[support^].
+
 == Contributing
 
 If you want to contribute to HiveMQ Heartbeat Extension, see the link:CONTRIBUTING.md[contribution guidelines].
 
 == License
 
-HiveMQ Heartbeat Extension is licensed under the `APACHE LICENSE, VERSION 2.0`. A copy of the license can be found link:LICENSE[here].
-
+HiveMQ Heartbeat Extension is licensed under the `APACHE LICENSE, VERSION 2.0`.
+A copy of the license can be found link:LICENSE[here].

build.gradle.kts

@@ -13,11 +13,7 @@ hivemqExtension {
     author.set("HiveMQ")
     priority.set(1000)
     startPriority.set(1000)
-    sdkVersion.set("4.9.0")
-
-    resources {
-        from("LICENSE")
-    }
+    sdkVersion.set("${property("hivemq-extension-sdk.version")}")
 }
 
 dependencies {
@@ -45,7 +41,6 @@ tasks.asciidoctor {
 hivemqExtension.resources {
     from("LICENSE")
     from("README.adoc") { rename { "README.txt" } }
-    from("dns-discovery-diagram.png")
     from(tasks.asciidoctor)
 }
 

gradle.properties

@@ -1,7 +1,8 @@
 version=1.0.4
 #
-# dependencies
+# main dependencies
 #
+hivemq-extension-sdk.version=4.2.0
 commons-lang.version=3.12.0
 commons-text.version=1.10.0
 jakarta-xml-bind.version=2.3.3