Skip to content

Commit 26019cb

Browse files
committed
update readme
1 parent 2674569 commit 26019cb

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,7 @@
22

33
## What is it?
44

5-
This library intends to be....todo
6-
7-
**Note** It currently is not fully featured/fully implemented. If there is a feature/end point that you
8-
need that is not yet implemented, please read the **[How to Contribute](#how-to-contribute)** section, or **[Create an issue](#)**
9-
requesting it.
5+
This library intends to give you an easy way to interact with the [Kafka-Connect](https://docs.confluent.io/current/connect/restapi.html) REST service (V4).
106

117
**Note** Use this library at your own risk! Currently there are no known issues, but as an **unofficial** library,
128
there are no guarantees.
@@ -19,19 +15,31 @@ This client library is released on Maven Central. Add a new dependency to your
1915
<dependency>
2016
<groupId>org.sourcelab</groupId>
2117
<artifactId>kafka-connect-client</artifactId>
22-
<version>0.1.0</version>
18+
<version>1.0.0</version>
2319
</dependency>
2420
```
2521

2622
Example Code:
2723
```java
28-
// TODO
24+
/*
25+
* Create a new configuration object.
26+
*
27+
* This configuration also allows you to define some optional details on your connection,
28+
* such as using an outbound proxy (authenticated or not).
29+
*/
30+
final Configuration configuration = new Configuration("hostname.for.kafka-connect.service.com:8083");
31+
32+
/*
33+
* Create an instance of ApiClient, passing your configuration.
34+
*/
35+
final ApiClient client = new ApiClient(configuration);
36+
37+
/*
38+
* Making requests by calling the public methods available on ApiClient.
39+
*/
2940
```
3041

31-
## What Features are implemented?
32-
33-
### Accounts
34-
Official Documentation: [TODO](#)
42+
Public methods available on ApiClient can be [found here](blob/master/src/main/java/org/sourcelab/kafka/connect/apiclient/ApiClient.java#L101-L266)
3543

3644
## How to Contribute
3745

pom.xml

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<groupId>org.sourcelab</groupId>
88
<artifactId>kafka-connect-client</artifactId>
9-
<version>0.1.0-SNAPSHOT</version>
9+
<version>1.0.0-SNAPSHOT</version>
1010
<packaging>jar</packaging>
1111

1212
<!-- Require Maven 3.3.9 -->
@@ -131,14 +131,6 @@
131131
<scope>test</scope>
132132
</dependency>
133133

134-
<!-- For mocking -->
135-
<dependency>
136-
<groupId>org.mockito</groupId>
137-
<artifactId>mockito-all</artifactId>
138-
<version>1.10.19</version>
139-
<scope>test</scope>
140-
</dependency>
141-
142134
<!-- Used in tests for reading files -->
143135
<dependency>
144136
<groupId>commons-io</groupId>

0 commit comments

Comments
 (0)