Generate polished README files from project code. Use when the user says "generate readme", "create README", "write project documentation", "make a readme", or asks for README generation, project documentation, installation docs, usage docs, API docs, badges, or repository onboarding documentation derived from an existing codebase.
---
name: readme-generator-free
description: Generate polished README files from project code. Use when the user says "generate readme", "create README", "write project documentation", "make a readme", or asks for README generation, project documentation, installation docs, usage docs, API docs, badges, or repository onboarding documentation derived from an existing codebase.
license: MIT
metadata:
version: 1.0.0
author: JustHandled Labs
triggers:
- generate readme
- create README
- write project documentation
- make a readme
---
# README Generator
Create a polished, accurate `README.md` from the project files that actually exist. Prefer evidence from manifests, source files, comments, and command output over generic filler.
## Workflow
1. Inspect the project root before writing:
- Node: `package.json`
- Python: `requirements.txt`, `pyproject.toml`, `setup.py`, or `setup.cfg`
- Go: `go.mod`
- Rust: `Cargo.toml`
- Java: `pom.xml`, `build.gradle`, or `build.gradle.kts`… install to load the full skill