Skip to content

Commit a5eb5ef

Browse files
committed
Added basic readme.
1 parent 339f234 commit a5eb5ef

File tree

1 file changed

+18
-65
lines changed

1 file changed

+18
-65
lines changed

README.adoc

Lines changed: 18 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,67 +1,20 @@
1-
//:hivemq-github: https://github.com/hivemq
2-
//:hivemq-website: http://www.hivemq.com
3-
//:hivemq-community-forum: https://community.hivemq.com/
4-
//:hivemq-extensions-docu: http://www.hivemq.com/docs/latest/extensions/
5-
//:hivemq-marketplace: http://www.hivemq.com/extensions/
6-
71
= HiveMQ Kafka Extension SDK
82

9-
//The enterprise MQTT broker HiveMQ offers this free, open source extension SDK.
10-
//The HiveMQ extension framework provides an open API that allows developers to create custom extensions that suit their specific infrastructures.
11-
//Use our extension framework to extend HiveMQ with custom business logic or to integrate virtually any system into HiveMQ.
12-
//
13-
//The HiveMQ extension framework can be used to add many different types of functionality:
14-
//
15-
//* Write messages to a database,
16-
//* integrate other services,
17-
//* collect statistics,
18-
//* add fine-grained security,
19-
//* and much more.
20-
//
21-
//Resources:
22-
//
23-
//* Web Site: {hivemq-website}
24-
//* Documentation: {hivemq-extensions-docu}
25-
//* Community Forum: {hivemq-community-forum}
26-
//* Contribution Guidelines: link:CONTRIBUTING.adoc[Contributing.adoc]
27-
//* License: The source files in this repository are made available under the link:LICENSE[Apache License Version 2.0].
28-
//
29-
//== Using the SDK
30-
//
31-
//The HiveMQ extension SDK is available in Maven central, so no special configuration is needed.
32-
//To use the SDK, add the following dependency to your Maven project:
33-
//
34-
//[source,xml]
35-
//----
36-
//<dependency>
37-
// <groupId>com.hivemq</groupId>
38-
// <artifactId>hivemq-extension-sdk</artifactId>
39-
// <version>4.3.0</version>
40-
//</dependency>
41-
//----
42-
//
43-
//== Extension Development Documentation
44-
//
45-
//Extension development for HiveMQ is as easy as writing a Java main method once you grasp the core concepts.
46-
//
47-
//Please visit the extensive {hivemq-extensions-docu}[HiveMQ extension developer documentation].
48-
//It covers the core concepts and shows how to set up your development environment.
49-
//
50-
//== Example Extensions
51-
//
52-
//You can find many example extensions by browsing the {hivemq-github}[HiveMQ GitHub space].
53-
//
54-
//Check out the {hivemq-marketplace}[HiveMQ Marketplace] for officially supported extensions.
55-
//
56-
//== Need help ?
57-
//
58-
//If you need help with custom HiveMQ extensions please contact support@hivemq.com.
59-
//
60-
//== Contributing
61-
//
62-
//If you want to contribute to the HiveMQ Extension SDK, see the link:CONTRIBUTING.md[contribution guidelines].
63-
//
64-
//== License
65-
//
66-
//The HiveMQ Extension SDK is licensed under the `APACHE LICENSE, VERSION 2.0`.
67-
//A copy of the license can be found link:LICENSE[here].
3+
== Using the SDK
4+
5+
The HiveMQ Kafka Extension SDK is available in Maven central, so no special configuration is needed.
6+
To use the SDK, add the following dependency to your Maven project:
7+
8+
[source,xml]
9+
----
10+
<dependency>
11+
<groupId>com.hivemq</groupId>
12+
<artifactId>hivemq-kafka-extension-sdk</artifactId>
13+
<version>4.4.0</version>
14+
</dependency>
15+
----
16+
17+
== License
18+
19+
The HiveMQ Extension SDK is licensed under the `APACHE LICENSE, VERSION 2.0`.
20+
A copy of the license can be found link:LICENSE[here].>>

0 commit comments

Comments
 (0)