docs: update README and quickstart to reflect AI-first workflow

- README quick start now leads with opening in an AI agent after init
- Quickstart docs updated: interactive wizard is default, --non-interactive
  replaces --human-friendly, edit step mentions AI agent workflow
This commit is contained in:
James
2026-03-27 22:47:13 +00:00
parent cb74ba7e71
commit c25fa84561
2 changed files with 13 additions and 6 deletions
+6 -1
View File
@@ -18,7 +18,12 @@ Hyperframes is an open-source video rendering framework that lets you create, pr
```bash
npx hyperframes init my-video
cd my-video
npx hyperframes dev # preview in browser
```
Then open the project with your AI coding agent (Claude Code, Cursor, etc.) — it has HyperFrames skills installed and knows how to create and edit compositions.
```bash
npx hyperframes dev # preview in browser (live reload)
npx hyperframes render # render to MP4
```
+7 -5
View File
@@ -3,7 +3,7 @@ title: Quickstart
description: "Create, preview, and render your first Hyperframes video in under two minutes."
---
Go from zero to a rendered MP4 in four steps: scaffold a project, preview it live, customize the composition, and render.
Go from zero to a rendered MP4: scaffold a project, edit with your AI agent, preview live, and render.
## What you'll build
@@ -58,14 +58,14 @@ A 1920x1080 video with an animated title that fades in from above — rendered t
<Steps>
<Step title="Scaffold the project">
```bash
npx hyperframes init my-video --template blank
npx hyperframes init my-video
cd my-video
```
The CLI is non-interactive by default — pass `--template` to select a template. For interactive mode with prompts and menus, add `--human-friendly`:
This starts an interactive wizard that walks you through template selection and media import. To skip prompts (e.g. in CI or from an agent), use `--non-interactive`:
```bash
npx hyperframes init --human-friendly
npx hyperframes init my-video --non-interactive --template blank
```
See [Templates](/guides/templates) for all available templates.
@@ -113,7 +113,9 @@ A 1920x1080 video with an animated title that fades in from above — rendered t
</Step>
<Step title="Edit the composition">
Open `index.html` and replace it with this composition:
Open the project with your AI coding agent (Claude Code, Cursor, etc.) — HyperFrames skills are installed automatically and your agent knows how to create and edit compositions.
Or edit `index.html` directly — here's a minimal composition:
```html index.html
<div id="root" data-composition-id="my-video"