From 1e6e476838e16186f49922864d659a6ab89c8ad5 Mon Sep 17 00:00:00 2001 From: James Date: Mon, 30 Mar 2026 20:27:06 +0000 Subject: [PATCH] docs(readme): add npm/license badges and move docs section up - 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) --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f9733081d..05d7d46cb 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Hyperframes +[![npm version](https://img.shields.io/npm/v/hyperframes.svg?style=flat)](https://www.npmjs.com/package/hyperframes) +[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) [![Node.js](https://img.shields.io/badge/node-%3E%3D22-brightgreen)](https://nodejs.org) **Write HTML. Render video. Built for agents.** @@ -29,6 +31,10 @@ npx hyperframes render # render to MP4 **Requirements:** Node.js >= 22, FFmpeg +## Documentation + +Full documentation at **[hyperframes.heygen.com](https://hyperframes.heygen.com)** — start with the [Quickstart](https://hyperframes.heygen.com/quickstart), then explore guides, concepts, API reference, and package docs. + ## How It Works Define your video as HTML with data attributes: @@ -102,10 +108,6 @@ npx skills add greensock/gsap-skills In Claude Code, invoke with `/hyperframes-compose`, `/hyperframes-captions`, `/gsap-core`, etc. -## Documentation - -Full docs at [hyperframes.heygen.com](https://hyperframes.heygen.com) — includes guides, concepts, API reference, and package documentation. - ## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute.