Skip to content

Improve README readability and project overview - #3

Merged
keemgdeok merged 2 commits into
mainfrom
docs/readme-refresh
Sep 16, 2026
Merged

keemgdeok merged 2 commits into
mainfrom
docs/readme-refresh

Conversation

@keemgdeok

Copy link
Copy Markdown
Owner

Summary

  • add concise Release, CI, and Java badges plus a clearer project value statement
  • keep Quick Start prominent and add a compact metadata flow diagram
  • surface rule behavior and the 100k-file benchmark in scannable tables
  • simplify release status, demo wording, and benchmark terminology
  • use the downloaded release JAR consistently in REST catalog examples

Verification

  • Spotless check passed
  • GitHub Markdown tables and Mermaid rendering verified
  • badge and documentation links verified
  • GitHub Actions build passed

Documentation only; no runtime behavior changed.

@keemgdeok
keemgdeok merged commit 6c5e1f3 into main Sep 16, 2026
2 checks passed
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.

1 participant