readme-writing

Installation
SKILL.md

README Writing

A folder README has one job: explain why this folder exists.

Users can run ls to see what's in a folder. They need you to explain the reasoning behind the organization, the mental model, and any non-obvious context that helps them understand where things belong.

Good README

Explains purpose, organizational logic, and helpful context:

# Converters

Transform field schemas into format-specific representations.

Field schemas are pure JSON Schema objects with `x-component` hints. Different systems need them in different formats: ArkType for runtime validation, Drizzle for SQLite column definitions.

Each converter takes the same input (a field schema) and produces output for a specific consumer. If you need field schemas in a new format, add a converter here.
Installs
14
GitHub Stars
4.6K
First Seen
Jan 20, 2026
readme-writing — epicenterhq/epicenter