ConnId README

README.md

@@ -1,2 +1,51 @@
-# ConnIdKafkaBundle
- ConnId: Kafka bundle 
+<!--
+
+    Copyright (C) 2024 ConnId (connid-dev@googlegroups.com)
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+            http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+-->
+ConnIdKafkaBundle
+==============
+
+The Kafka bundle is part of the [ConnId](http://connid.tirasa.net) project.
+
+<a href="https://github.com/Tirasa/ConnIdKafkaBundle/actions/workflows/ci.yml">
+  <img src="https://github.com/Tirasa/ConnIdKafkaBundle/actions/workflows/ci.yml/badge.svg"/>
+</a>
+<a href="#">
+  <img src="https://img.shields.io/maven-central/v/net.tirasa.connid.bundles/net.tirasa.connid.bundles.kafka.svg"/>
+</a>
+
+## How to get it
+
+### Maven
+
+```XML
+<dependency>
+  <groupId>net.tirasa.connid.bundles</groupId>
+  <artifactId>net.tirasa.connid.bundles.kafka</artifactId>
+  <version>${connid.kafka.version}</version>
+</dependency>
+```
+
+where `connid.kafka.version` is one of [available](http://repo1.maven.org/maven2/net/tirasa/connid/bundles/net.tirasa.connid.bundles.kafka/).
+
+### Downloads
+
+Available from [releases](https://github.com/Tirasa/ConnIdKafkaBundle/releases).
+
+## Project information
+
+ * [wiki](https://connid.atlassian.net/wiki/display/BASE/Kafka)
+ * [issues](https://connid.atlassian.net/browse/KAFKA)