Skip to content

docs: rewrite README with comprehensive examples#26

Merged
uael merged 1 commit intomainfrom
docs/readme-rewrite
Mar 8, 2026
Merged

docs: rewrite README with comprehensive examples#26
uael merged 1 commit intomainfrom
docs/readme-rewrite

Conversation

@uael
Copy link
Copy Markdown
Owner

@uael uael commented Mar 8, 2026

Summary

  • Rewrote README to better demonstrate the crate's power with real code examples
  • Added "Why nearest?" section, feature table, and comparison vs rkyv/FlatBuffers/bumpalo
  • Added ASCII buffer layout diagram and links to all 5 runnable examples
  • Fixed list([])empty() for empty NearList construction (type inference)

Test plan

  • All doc tests pass (cargo test --doc)
  • All integration tests pass (cargo test)
  • All 5 examples run successfully
  • Formatting check passes (cargo xtask fmt --check)

🤖 Generated with Claude Code

Rewrite README to better showcase the crate's capabilities:
- Punchy tagline and quick-look example
- "Why nearest?" value proposition section
- Detailed examples: expression trees, branded sessions, no_std, region composition
- Feature table and comparison vs rkyv/FlatBuffers/bumpalo
- ASCII buffer layout diagram explaining how it works
- Links to all runnable examples

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@uael uael merged commit 74797c6 into main Mar 8, 2026
7 checks passed
@uael uael deleted the docs/readme-rewrite branch March 8, 2026 19:25
@github-actions github-actions Bot mentioned this pull request Mar 8, 2026
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