README Generator
Create a professional README.md for any project or repository
Template Fields
Project NametextRequired
e.g., FlowState, react-data-grid, my-api
Project TypeselectRequired
Library/PackageCLI ToolWeb ApplicationAPIMobile AppFrameworkPlugin/Extension
Project DescriptionmultilineRequired
What does it do? Why does it exist? Key features
Tech StacktextRequired
e.g., TypeScript, React, Node.js, PostgreSQL
Installation StepsmultilineRequired
How to install and set up (commands, requirements)
Basic Usage ExamplemultilineRequired
A simple code example showing core functionality
Licenseselect
MITApache-2.0GPL-3.0BSD-3-ClauseProprietary
Related Templates
Bug Report
Write a clear, actionable bug report that developers can act on immediately
API Endpoint Documentation
Document an API endpoint with request/response examples
API Documentation
ProComprehensive API documentation with examples and best practices
System Design Document
ProDetailed system architecture and design documentation