docs(readme): clarify HyperFrames positioning#1096
Conversation
|
|
||
| If you hit `git-lfs filter-process: command not found` during `git clone` or `npx skills add heygen-com/hyperframes`, install Git LFS and retry. You can also skip LFS content if you only need the source files: | ||
| If you only need source files, you can skip LFS content: | ||
|
|
There was a problem hiding this comment.
should we add the adopters in the readme?
There was a problem hiding this comment.
My instinct is to keep the README as a lightweight pointer rather than duplicating the adopters table here. The list may grow over time, and then we either end up with a long section in the README or a second copy that has to stay in sync with ADOPTERS.md. That feels like an anti-pattern for the repo front door. I think the README should state the proof point briefly and link to ADOPTERS.md as the source of truth.
There was a problem hiding this comment.
makes sense, what about just adding the biggest adopters like tanstack and tldraw? and we can remove them if there is a lot of adoption
There was a problem hiding this comment.
just for teasing people tbh, but your decision is also good
| | Agent skills | Available | Teach coding agents the video-production patterns that generic web docs miss | | ||
| | Studio | Available, evolving | Browser surface for previewing and editing compositions | | ||
| | AWS Lambda rendering | Available | Deploy a distributed render stack and drive renders from your laptop or CI | | ||
| | Design.HTML | In development | Hosted authoring flow for turning design intent into renderable HyperFrames compositions | |
There was a problem hiding this comment.
this is not correct it's more so visualizing your brand identity and making it more usable for videos
| | Studio | Available, evolving | Browser surface for previewing and editing compositions | | ||
| | AWS Lambda rendering | Available | Deploy a distributed render stack and drive renders from your laptop or CI | | ||
| | Design.HTML | In development | Hosted authoring flow for turning design intent into renderable HyperFrames compositions | | ||
| | hyperframes.dev app | In development | Hosted workflows for previewing, iterating, sharing, and rendering HTML-native video projects | |
There was a problem hiding this comment.
should we add a link here ?
| Preview instantly in the browser. Render to MP4 locally or in Docker. | ||
| Preview instantly in the browser. Render locally or in Docker. The renderer seeks each frame in headless Chrome and encodes the result with FFmpeg, so the same input produces the same video. | ||
|
|
||
| ## HyperFrames Stack |
There was a problem hiding this comment.
I wonder if this should move up but maybe it's in the right place for now
jrusso1020
force-pushed
the
05-27-docs_readme_clarify_hyperframes_positioning
branch
3 times, most recently
from
69d5d4f to
b061a14
Compare
jrusso1020
force-pushed
the
05-27-docs_readme_clarify_hyperframes_positioning
branch
from
b061a14 to
23717a9
Compare
4 participants
What
Rewrite the root README to:
Why
The old README mixed onboarding, plugin details, comparison, and contributor notes before readers had a quick mental model. This version keeps the first-use path clear while still showing the broader ecosystem we are building around the open-source renderer.
How
This is a documentation-only README rewrite. It keeps the existing logo, badges, and demo asset, but reorganizes the content around quick start, use cases, how it works, ecosystem, catalog, positioning, docs, packages, community, and development notes.
Test plan
Validation:
bun run format:check./node_modules/.bin/oxfmt --check README.mdgit diff --check