Skip to content

docs(readme): add standard badges and move docs section up#139

Merged
jrusso1020 merged 1 commit intomainfrom
docs/improve-readme-badges-and-docs-link
Mar 30, 2026
Merged

docs(readme): add standard badges and move docs section up#139
jrusso1020 merged 1 commit intomainfrom
docs/improve-readme-badges-and-docs-link

Conversation

@jrusso1020
Copy link
Copy Markdown
Collaborator

Summary

Testing

- Add npm version and MIT license badges (matching React/Remotion/Next.js conventions)
- Remove non-standard Docs badge
- Move Documentation section from bottom of README to right after Quick Start
  for better discoverability (follows patterns from React, Remotion, Vite)
- Link to quickstart at hyperframes.heygen.com/quickstart

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jrusso1020 jrusso1020 merged commit 163da68 into main Mar 30, 2026
14 checks passed
@jrusso1020 jrusso1020 deleted the docs/improve-readme-badges-and-docs-link branch March 30, 2026 20:38
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.

2 participants