Skip to content

Commit 782f2bd

Browse files
author
Julien Ruaux
committed
docs: Updated README
1 parent 8f22ade commit 782f2bd

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

README.adoc

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,38 @@
1-
= Redis Kafka Connector
1+
= Redis Kafka Connector (Source and Sink) by Redis
22
:linkattrs:
33
:project-owner: redis-field-engineering
44
:project-name: redis-kafka-connect
55
:project-group: com.redis
66
:project-version: 7.1
7+
:project-url: https://github.com/{project-owner}/{project-name}
8+
:documentation-url: https://{project-owner}.github.io/{project-name}
79

8-
image:https://github.com/{project-owner}/{project-name}/actions/workflows/early-access.yml/badge.svg["Build Status", link="https://github.com/{project-owner}/{project-name}/actions"]
10+
11+
image:https://github.com/{project-owner}/{project-name}/actions/workflows/early-access.yml/badge.svg["Build Status", link="{project-url}/actions"]
912
image:https://codecov.io/gh/{project-owner}/{project-name}/branch/master/graph/badge.svg?token=MTMRRGEWBD["Coverage", link="https://codecov.io/gh/{project-owner}/{project-name}"]
1013

11-
Kafka Connect source and sink connectors for Redis
14+
Redis Kafka Connector (Source and Sink) by Redis.
1215

1316
== Documentation
1417

15-
Refer to the link:https://{project-owner}.github.io/{project-name}[documentation] for configuration and usage information.
18+
Documentation is available at link:{documentation-url}[{documentation-url}]
19+
20+
== Downloading
21+
22+
The connector is published on https://www.confluent.io/hub/redis/redis-enterprise-kafka[Confluent Hub] and {project-url}/releases/latest[Github].
23+
24+
== Support
25+
26+
Contact us on the https://forum.redis.com/[Redis Forum] or create an issue on {project-url}/issues[Github] where we provide support on a good faith effort basis.
1627

1728
== Docker Example
1829

19-
Run `run.sh` and follow prompts
30+
Clone this repository, execute `run.sh` and follow prompts:
31+
32+
[source,console,subs="verbatim,attributes"]
33+
----
34+
git clone {project-url}
35+
cd {project-name}
36+
./run.sh
37+
----
38+

0 commit comments

Comments
 (0)