readme-generator-freelisted
Install: claude install-skill justhandledlabs/skills
# 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`
- Make commands: `Makefile`
- License: `LICENSE`, `LICENSE.md`, or package manifest license fields
2. Detect the main entry point:
- Node/TypeScript: `package.json` `main`, `bin`, `exports`, `src/index.ts`, `src/index.js`, `index.js`, or `server.js`
- Python: `main.py`, `app.py`, package console scripts, or `__main__.py`
- Go: `main.go` or `cmd/*/main.go`
- Rust: `src/main.rs`, `src/lib.rs`, or `[[bin]]` entries in `Cargo.toml`
- Java: Maven/Gradle application plugin config or `src/main/java/**/Main.java`
3. Extract dependencies only from actual manifests:
- Node: `dependencies`, `devDependencies`, `peerDependencies`, and `optionalDependencies`
- Python: `requirements.txt`, `pyproject.toml`, `setup.py`, or `setup.cfg`
- Go: `require` blocks in `go.mod`
- Rust: `[dependencies]`, `[dev-dependencies]`, and `[build-dependencies]`
- Java: Maven dependencies or Gradle dependencies
4. Extract scripts and commands:
- Node: `package.json` `scripts`
- Make: targets from `Makefile`
- Pyt