Generate Comprehensive Project READMEs

This skill creates comprehensive, well-structured README files following a logical hierarchy: project title and description, status badges, installation instructions, usage examples, API/documentation reference, contributing guidelines, license, and acknowledgments. It covers badge selection (build status, npm version, license, coverage), multi-method installation blocks (npm, yarn, CDN, prerequisites), quick-start and advanced usage code examples, structured API reference documentation with parameter tables, environment/configuration documentation, contributing workflow steps, and a troubleshooting/FAQ section.

Use this skill when writing a new README from scratch or improving a thin one - adding status badges, writing clear installation steps for multiple package managers, documenting an API function's parameters and return type, building a configuration options table, drafting contributor setup steps and test commands, or adding a troubleshooting section for common errors.

It does not cover generating full API reference sites (e.g. Sphinx/JSDoc-generated docs) or marketing landing pages - it is focused specifically on the repository-level README document.

It also documents concrete prerequisites (e.g. Node.js >= 14.0.0, Python >= 3.8 for optional features) and a full contributor workflow: fork the repository, create a feature branch, install dependencies, run tests, commit, push, and open a pull request, plus separate test commands for a full run, watch mode, and coverage reporting.

Inputs are typically the project's name, purpose, installation method, and public API. Outputs are a structured Markdown README with sections such as:

### `processData(input, options)`

Processes input data according to specified options.

**Parameters:**
- `input` (string|object) - The data to process
- `options` (object) - Configuration options
  - `format` (string) - Output format ('json', 'xml', 'csv')
  - `validate` (boolean) - Enable input validation (default: true)

**Returns:** Promise<ProcessResult>

Other outputs include a badge row (build, npm version, license, coverage), a multi-method installation section, a configuration options table with type/default/description columns, a contributing section with fork-branch-test-PR steps, a troubleshooting section for common errors, and formatting tips (keep the description under 160 chars, add a table of contents past 100 lines, maintain consistent heading hierarchy).

It can also produce a .env configuration block (API key, environment, log level, database URL) alongside a configuration options table with type/default/description columns for options such as apiKey, baseURL, timeout, and retries, a mermaid architecture diagram showing request flow through validation, processing, and output-formatting layers, and a performance benchmarks table (operation, time in ms, memory in MB, throughput in ops/sec) for projects that want to document measured behavior.

Open-source maintainers and developers who need a complete, professional README that helps with project adoption and contributor onboarding rather than a bare one-paragraph description.