block-readme

What problem does it solve?

Block READMEs are often inconsistent and hard to maintain. This skill provides a single, official template and workflow to create or update a block README.md that clearly describes the block's purpose, usage, and extension points.

Core Features & Use Cases

• Template-driven structure — enforces a consistent README layout for all blocks.
• Brand override guidance — explains how to adapt blocks per brand and token overrides.
• UE fields, variants, and events — documents the fields used by the Universal Editor, available variants, and dispatched events.
• Use Case — after implementing or significantly updating a block, generate its README to reflect current implementation and guidelines.

Quick Start

Create or update the block's README.md using the official template after finishing the block.