Skip to content

Commit

Permalink
PR review
Browse files Browse the repository at this point in the history
  • Loading branch information
FP17000 committed Sep 21, 2023
1 parent b8d504b commit bce4f4f
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 13 deletions.
17 changes: 4 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,11 @@
[![SonarCloud Coverage](https://img.shields.io/sonar/coverage/michelin_kstreamplify?logo=sonarcloud&server=https%3A%2F%2Fsonarcloud.io&style=for-the-badge)](https://sonarcloud.io/component_measures?id=michelin_kstreamplify&metric=coverage&view=list)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?logo=apache&style=for-the-badge)](https://opensource.org/licenses/Apache-2.0)

So here you are, sitting on your chair in that open space, scratching your head thinking "I really wish Kafka Streams was easier to implement...
If only there was someone out there who made a lib, somewhere, that would guarantee that my app doesn't crash loop in production because I forgot to null-safe that map node..." Well, guess what - Kstreamplify is THAT lib.
Yes. You're welcome!

Oh, and also, you'll have access to a bunch of advanced utility classes providing simplified topic declarations, idempotence, topic prefixing and dynamic remaping...
Making it wayyy easier to code Kstreams applications at lightning speed.
Do you wish to improve your dev experience and implement Kafka Streams libraries at lightning speed? Then Kstreamplify is made just for you!
This Java library enables the rapid creation of Kafka Streams-based applications, while providing a bunch of additionnal advanced features.

Declare your KafkaStreams class as below and define your topology :
![](gifs/topology.gif "Spring topology gif")

## Table of Contents

Expand Down Expand Up @@ -58,7 +56,6 @@ These dependencies are compatible with Java Standard Edition (SE).
<artifactId>kstreamplify-core</artifactId>
<version>${kstreamplify.version}</version>
</dependency>

<dependency>
<groupId>com.michelin</groupId>
<artifactId>kstreamplify-core-test</artifactId>
Expand All @@ -67,8 +64,6 @@ These dependencies are compatible with Java Standard Edition (SE).
</dependency>
```

![](gifs/pom.gif "Pom gif")


### Spring Boot

Expand All @@ -90,8 +85,6 @@ If you are using Spring Boot, you can use the following dependency to integrate

The dependency is compatible with Spring Boot 3.

![](gifs/pom_spring.gif "Spring pom gif")


## Getting Started

Expand All @@ -109,8 +102,6 @@ public class MyKafkaStreams extends KafkaStreamsStarter {
}
```

![](gifs/topology.gif "Spring topology gif")

Alternatively, you can annotate a method that returns a `KafkaStreamsStarter` with `@Bean`:

```java
Expand Down
Binary file removed gifs/pom.gif
Binary file not shown.
Binary file removed gifs/pom_spring.gif
Binary file not shown.
Binary file modified gifs/topology.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bce4f4f

Please sign in to comment.