Skip to content

docs: expand README and prepare 0.4.0 changelog - #199

Merged
tisonkun merged 1 commit into
mainfrom
codex/readme-changelog-0.4.0
Aug 12, 2026
Merged

docs: expand README and prepare 0.4.0 changelog#199
tisonkun merged 1 commit into
mainfrom
codex/readme-changelog-0.4.0

Conversation

@tisonkun

Copy link
Copy Markdown
Member

Summary

  • expand the README with a getting-started example, sketch feature matrix, compatibility notes, and Apache community, security, and license guidance
  • rebuild the Unreleased changelog from the final diff between 0.3.0 and main
  • document the public migrations, features, and correctness fixes that users will observe while excluding internal work and APIs that were introduced and removed during 0.4.0 development

Changelog scope

The 0.3.0 tag is the comparison baseline. Entries describe the final 0.4.0-facing behavior rather than the sequence of implementation changes that led to it.

Validation

  • cargo x prepare-testdata
  • cargo x check
  • cargo x test
  • cargo x lint
  • README external links checked

@tisonkun
tisonkun marked this pull request as ready for review August 12, 2026 01:33
@tisonkun
tisonkun merged commit 8aeecb9 into main Aug 12, 2026
10 checks passed
@tisonkun
tisonkun deleted the codex/readme-changelog-0.4.0 branch August 12, 2026 01:33
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