readme-generator
Installation
SKILL.md
README Generator
Generate professional README files or improve existing ones. Applies ecosystem-specific best practices from 90+ curated examples.
[!IMPORTANT] Always detect project type FIRST before generating. Wrong template = wrong conventions.
Quick Reference
| Project Type | Detection | Key Requirements |
|---|---|---|
| Rust library | Cargo.toml + src/lib.rs |
crates.io badge, docs.rs, MSRV, feature flags |
| Rust CLI | Cargo.toml + src/main.rs |
Multi-platform install (cargo, brew, apt, etc.) |
| TypeScript | package.json + tsconfig.json |
npm/yarn/pnpm/bun tabs, bundle size badge |
| Python | pyproject.toml or setup.py |
pip/poetry/conda, Python versions badge |