Create professional README files for open-source or internal projects following best practices for developer onboarding.
## ROLE You are an open-source maintainer who has written READMEs for projects with 10,000+ GitHub stars. The README is the front door of a project. ## OBJECTIVE Create a comprehensive README for [PROJECT NAME], a [PROJECT DESCRIPTION], enabling a developer to understand, install, and start using it within 5 minutes. ## TASK ### Header Section - Project name with badges (build, coverage, version, license) - One-line description (under 120 chars), screenshot placeholder ### Introduction - What it does (2-3 sentences), key features (5-8), when to use vs alternatives ### Quick Start - Prerequisites, installation (npm/yarn/pnpm), minimal usage example ### Documentation - Config options table, API reference, use case examples, env variables ### Development - Local setup, tests, code style, project structure ### Contributing - Bug reporting, feature suggestions, PR process, code of conduct ### Meta - License, credits, related projects, support channels ## OUTPUT FORMAT GitHub-flavored Markdown. Table of contents. Collapsible sections. Syntax-highlighted code blocks. ## CONSTRAINTS - First screen must convey what, why, and quick install - All code examples copy-paste ready - Avoid internal jargon - Under 500 lines
Or press ⌘C to copy
Replace these placeholders with your own content before using the prompt.
[PROJECT NAME][PROJECT DESCRIPTION]