Skip to content

Commit

Permalink
Update project readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mmodzelewski committed Oct 22, 2024
1 parent 9247859 commit 583abcb
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
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.

0 comments on commit 583abcb

Please sign in to comment.