Skip to content

Commit

Permalink
Merge pull request #15 from bsoaressimoes/rework-readme
Browse files Browse the repository at this point in the history
doc(readme): add badges in the readme
  • Loading branch information
flazarus1A authored Jan 19, 2024
2 parents f2ce4a2 + 348d331 commit 471172c
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
# Quarkus Kafka Streams Processor

[![Version](https://img.shields.io/maven-central/v/io.quarkiverse.kafkastreamsprocessor/quarkus-kafka-streams-processor?logo=apache-maven&style=flat-square)](https://search.maven.org/artifact/io.quarkiverse.kafkastreamsprocessor/quarkus-kafka-streams-processor)

[//]: # ( TODO after running the build on github)
[//]: # ([![Build]&#40;<https://img.shields.io/github/actions/workflow/status/quarkiverse/quarkus-kafka-streams-processor/build.yml?branch=main&logo=GitHub&style=flat-square>&#41;]&#40;https://github.com/quarkiverse/quarkus-kafka-streams-processor/actions?query=workflow%3ABuild&#41;)

[![Build](https://github.com/quarkiverse/quarkus-logging-splunk/workflows/Build/badge.svg)](https://github.com/quarkiverse/quarkus-kafka-streams-processor/actions?query=workflow%3ABuild)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square)](https://opensource.org/licenses/Apache-2.0)
[![Version](https://img.shields.io/maven-central/v/io.quarkiverse.kafkastreamsprocessor/quarkus-kafka-streams-processor?logo=apache-maven&style=flat-square)](https://search.maven.org/artifact/io.quarkiverse.kafkastreamsprocessor/quarkus-kafka-streams-processor)
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->

## Getting Started
This extension eases the implementation of event-driven architecture streaming microservices based on [Kafka Streams’](https://kafka.apache.org/documentation/streams/) Processor API.
It avoids Kafka Streams' users a lot of boilerplate code to have a dedicated topology and a proper production readiness (health, observability, error handling).
All that is left to develop is a simple Processor class.
The extension takes care of the rest.

[//]: # (TODO after uploading the userguide to quarkiverse docs)
For more details, check the complete [documentation](https://quarkiverse.github.io/quarkiverse-docs/quarkus-kafka-streams-processor/dev/index.html).

## How to build the extension
Expand Down

0 comments on commit 471172c

Please sign in to comment.