rc-readmelisted

Creates or updates a project README by analyzing the real codebase, then rewriting README.md with accurate, evidence-based content — or guides writing/improving a README by hand with templates and guidance matched to audience and project type (open source, personal, internal, config). Use when generating a README from scratch, refreshing an outdated one, syncing docs after features land, or drafting/reviewing a README manually. Do not use for API reference files (use rc-openapi or rc-postman), changelog generation, or editing source code.
rodolfochicone/rc-project · ★ 19 · AI & Automation · score 76

Install: claude install-skill rodolfochicone/rc-project

# README Produce a `README.md` that reflects what the code actually does — never invented or aspirational content. Every claim must trace back to a file you read. This skill is standalone and stack-agnostic; it detects the project's technology before writing. ## Required Inputs - None. Operates on the current repository root. - Optional: a target path other than `README.md`, or specific sections to scope the update to. ## Workflow 1. Gather documentation context. - Read, when present: the existing `README.md`, `CLAUDE.md`, `AGENTS.md`, `CONTRIBUTING.md`, any `docs/` overview, and architecture notes or ADRs under `docs/`, `.techdocs/`, or `.rc/tasks/*/adrs/` (in monorepos there may be more than one `.rc` directory — scan each one, skipping `node_modules`, `.git`, `vendor`, and `_archived/`). - The existing README defines the structure and tone to preserve. Keep valid sections; only rewrite what is stale. 2. Detect the stack and analyze the codebase. Read real sources — do not guess. - **Manifest and stack**: inspect `go.mod`, `package.json`, `pyproject.toml`, `Cargo.toml`, `pom.xml`, `*.csproj`, `Gemfile`, etc. Record real dependency versions, the language, frameworks, and the package/registry. - **Entry points and public API**: the binary `main`, exported packages, library entry, or CLI commands. - **HTTP / RPC surface**: route definitions, handlers, controllers, or service files. Capture method, path, and the request/response contract from the validation