(feat/readme) feat: Added README.md and fixed an issue on changelog c…

[nil-malh]

…ommit to main

📝 Description

Resolves #

---

🔄 Type of Change

• 🐛 Bug fix — non-breaking change that fixes an issue
• ✨ New feature — non-breaking change that adds functionality
• 💥 Breaking change — fix or feature that changes existing behaviour
• ♻️ Refactoring / technical debt — no functional change
• 📖 Documentation — doc-only changes
• ⬆️ Dependency update — bumped library/plugin version(s)
• 🔧 CI / build — changes to workflows, pom.xml, tooling

---

✅ Pre-Merge Checklist

Code Quality

• My code follows the Palantir Java Format style (passes mvn spotless:check)
• I have added or updated Javadoc on public types and methods

Tests

• I have added unit tests that cover the new / changed behaviour
• All existing and new tests pass locally (mvn verify)
• JaCoCo line coverage ≥ 70 % is maintained
• Tests using Testcontainers are isolated and do not leave containers running

Licensing

• Apache 2.0 license header has been added to every new source file (using spotless)

---

🧪 How to Test Locally

# 1. Build and run all tests (requires Docker for Testcontainers)
mvn verify

# 2. Check code style
mvn spotless:check

---

📸 Screenshots / Logs

---

📚 Additional Context

[github-actions]

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

[github-actions]

📋 Unreleased Changelog Preview

This is what the next release notes will look like based on commits in this PR.

Changelog

All notable changes to this project will be documented in this file.

[Unreleased]

⬆️ Dependency Updates

• Bump com.diffplug.spotless:spotless-maven-plugin (deps-dev) — @dependabot[bot]

• Bump org.slf4j:slf4j-api in the logging group (deps) — @dependabot[bot]

• Bump the kafka group with 2 updates (deps) — @dependabot[bot]

• Bump the kafka group across 1 directory with 2 updates (deps) — @dependabot[bot]

• Bump the junit5 group across 1 directory with 3 updates (deps-dev) — @dependabot[bot]

🐛 Bug Fixes

• Fixed an issue where a release on GitHub would not have the jars attached — @nil-malh

---

Generated by git-cliff

---

🔄 Run #76 · Mon, 01 Jun 2026 19:48:51 GMT

[github-actions]

✅ Test Results

	Metric	Count
✅	Passed	655
❌	Failed	0
⏭️	Skipped	0
📊	Total	655

✅ Coverage

	Type	Coverage	Covered / Total
📏	Lines	83.7%	1720 / 2056
🌿	Branches	72.8%	519 / 713
🔧	Methods	83.3%	359 / 431

---

🔄 CI run #96 · Mon, 01 Jun 2026 19:52:33 GMT

[nil-malh]

LGTM !