Skip to content

docs: refresh README for 1.0 - #104

Open
endrju19 wants to merge 4 commits into
mainfrom
docs/readme-1.0-refresh
Open

docs: refresh README for 1.0#104
endrju19 wants to merge 4 commits into
mainfrom
docs/readme-1.0-refresh

Conversation

@endrju19

Copy link
Copy Markdown
Collaborator

Summary

  • restructure the README around a concise Spring Boot quick start and verified runtime behavior
  • clarify delivery guarantees, retries, transactions, configuration, metrics, modules, and compatibility
  • move the pre-1.0 migration procedure out of the README into UPGRADING.md
  • add the Okapi module diagram from the SoftwareMill article

Verification

  • git diff --check
  • OkapiMicrometerAutoConfigurationTest (14 tests passed)
  • migration instructions were not executed, as they are outside the scope of this documentation change

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