Skip to content

Expand README with quick start, delivery guarantees, and module diagram (KOJAK-33)#9

Merged
endrju19 merged 3 commits intomainfrom
kojak-33-readme
Mar 30, 2026
Merged

Expand README with quick start, delivery guarantees, and module diagram (KOJAK-33)#9
endrju19 merged 3 commits intomainfrom
kojak-33-readme

Conversation

@endrju19
Copy link
Copy Markdown
Collaborator

Summary

  • Expanded README from 87 to 147 lines with SML portfolio conventions
  • Added badges: Discourse, CI, dynamic Kotlin version (reads from libs.versions.toml), JVM 21, License
  • Added Quick Start (Spring Boot) with 3 code blocks: BOM dependencies, HttpMessageDeliverer bean, SpringOutboxPublisher usage with constructor injection
  • Added "How It Works" section with delivery guarantees (at-least-once, concurrent processing, error classification)
  • Added Mermaid module dependency diagram + expanded modules table (now includes okapi-mysql)
  • Added Contributing section (ox pattern, adapted for Kotlin/Gradle), Project sponsor, Copyright
  • Removed standalone usage section (deferred to KOJAK-40 when okapi-ktor is available)

Test plan

  • Verify Mermaid diagram renders on GitHub
  • Verify dynamic Kotlin badge shows correct version
  • Verify all links are reachable
  • Verify badge images load

Dynamic Kotlin badge reads version from libs.versions.toml via
shields.io — auto-updates on Kotlin bumps. JVM 21 badge signals
the minimum runtime requirement.
…mples (KOJAK-33)

- Show serviceName parameter in ServiceUrlResolver example (not hardcoded URL)
- Add Kafka deliverer bean + publish snippet
- Add MySQL swap note
@endrju19 endrju19 merged commit c0b1e46 into main Mar 30, 2026
7 checks passed
@endrju19 endrju19 deleted the kojak-33-readme branch March 30, 2026 07:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants