Skip to content

Commit

Permalink
doc(readme): add badges in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bsoaressimoes committed Jan 19, 2024
1 parent 7f29071 commit d61e528
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 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 All @@ -29,15 +28,17 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>

<tr>
<td align="center"><a href="https://github.com/vietk"><img src="https://avatars.githubusercontent.com/u/1568850?v=4?s=100" width="100px;" alt=""/><br /><sub><b>vietk</b></sub></a><br /><a href="https://github.com/quarkiverse/quarkus-kafka-streams-processor/commits?author=vietk" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/rquinio1A"><img src="https://avatars.githubusercontent.com/u/58322910?v=4?s=100" width="100px;" alt=""/><br /><sub><b>rquinio1A</b></sub></a><br /><a href="https://github.com/quarkiverse/quarkus-kafka-streams-processor/commits?author=rquinio1A" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/edeweerd1A"><img src="https://avatars.githubusercontent.com/u/151753129?v=4" width="100px;" alt=""/><br /><sub><b>edeweerd1A </b></sub></a><br /><a href="https://github.com/quarkiverse/quarkus-kafka-streams-processor/commits?author=edeweerd1A" title="Code">💻</a> </td>
<td align="center"><a href="https://github.com/flazarus1A"><img src="https://avatars.githubusercontent.com/u/58324636?v=4" width="100px;" alt=""/><br /><sub><b>flazarus1A</b></sub></a><br /><a href="https://github.com/quarkiverse/quarkus-kafka-streams-processor/commits?author=flazarus1A" title="Code">💻</a> </td>
<td align="center"><a href="https://github.com/tryasta"><img src="https://avatars.githubusercontent.com/u/15208442?v=4" width="100px;" alt=""/><br /><sub><b>tryasta</b></sub></a><br /><a href="https://github.com/quarkiverse/quarkus-kafka-streams-processor/commits?author=tryasta" title="Code">💻</a> </td>
<td align="center"><a href="https://github.com/lmartella1"><img src="https://avatars.githubusercontent.com/u/147706653?v=4" width="100px;" alt=""/><br /><sub><b>lmartella1</b></sub></a><br /><a href="https://github.com/quarkiverse/quarkus-kafka-streams-processor/commits?author=lmartella1" title="Code">💻</a> </td>
</tr>
</tr
</table>



This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Any kind of contributions are welcome!

0 comments on commit d61e528

Please sign in to comment.