-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9247859
commit 583abcb
Showing
1 changed file
with
15 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,27 @@ | ||
# Java SDK for Iggy | ||
|
||
[Iggy GitHub](https://github.com/iggy-rs/iggy) | [Website](https://iggy.rs) | [Getting started](https://docs.iggy.rs/introduction/getting-started/) | [Documentation](https://docs.iggy.rs) | [Discord](https://iggy.rs/discord) | ||
[Iggy GitHub](https://github.com/iggy-rs/iggy) | [Website](https://iggy.rs) | [Getting started](https://docs.iggy.rs/introduction/getting-started/) | [Documentation](https://docs.iggy.rs) | [Blog](https://blog.iggy.rs) | [Discord](https://iggy.rs/discord) | ||
|
||
[![Tests](https://github.com/iggy-rs/iggy-java-client/actions/workflows/tests.yml/badge.svg)](https://github.com/iggy-rs/iggy-java-client/actions/workflows/tests.yml) | ||
[![x](https://img.shields.io/twitter/follow/iggy_rs_?style=social)](https://twitter.com/iggy_rs_) | ||
|
||
--- | ||
|
||
Official Java client SDK for [Iggy.rs](https://iggy.rs) message streaming. | ||
|
||
> [!WARNING] | ||
> The Java SDK is currently in early development and is not yet ready for production use. | ||
The client currently supports HTTP and TCP protocols with blocking implementation. | ||
|
||
## To do | ||
### Adding the client to your project | ||
|
||
- Transport protocols | ||
- QUIC | ||
- Publish maven package | ||
- Add examples | ||
Add dependency to `pom.xml` or `build.gradle` file. | ||
|
||
You can find the latest version in Maven Central repository: | ||
|
||
https://central.sonatype.com/artifact/rs.iggy/iggy-java-sdk | ||
|
||
### Implement consumer and producer | ||
|
||
You can find examples for | ||
simple [consumer](https://github.com/iggy-rs/iggy-java-client/blob/main/examples/simple-consumer/src/main/java/rs/iggy/SimpleConsumer.java) | ||
and [producer](https://github.com/iggy-rs/iggy-java-client/blob/main/examples/simple-producer/src/main/java/rs/iggy/SimpleProducer.java) | ||
in the repository. |