Skip to content

docs: rewrite README to match docs site - #1

Merged
hunterbecton merged 1 commit into
mainfrom
docs/rewrite-readme
Apr 30, 2026
Merged

hunterbecton merged 1 commit into
mainfrom
docs/rewrite-readme

Conversation

@hunterbecton

@hunterbecton hunterbecton commented Apr 30, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Replaced starter template boilerplate with user-facing content from the docs site
  • Added installation, usage examples, bone types reference, and skeleton preview docs
  • Removed internal mermaid diagram

Test plan

  • Verify README renders correctly on GitHub
  • Confirm code examples match current API

Replace the starter template boilerplate and internal mermaid diagram
with user-facing content: project description, installation, usage
examples, bone types reference, and skeleton preview docs.
@hunterbecton
hunterbecton merged commit 29053a2 into main Apr 30, 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