readme-generator

@randalolson/readme-generator

Use when a code repository needs a README a newcomer can rely on to understand, install, and run the project, and you want it to stay accurate to the actual code; works for any language and handles monorepos.

Outcome

A newcomer can understand, install, and run the project from its README on the first attempt, and the README's commands and links stay accurate to the code.

readme documentation developer-tools onboarding

Use this template

Your agent fetches this runbook and runs it, revising the output until the verifiers pass.

First time with Goodeye?

Connect your agent over MCP, then ask it to fetch this template by its identifier. Or install the CLI and run the command below.

Connect your agent (Claude Code)

claude mcp add --transport http goodeye https://mcp.goodeye.dev/mcp

Or install the CLI

uv tool install goodeye

Connecting over MCP prompts a quick sign-in. The CLI can fetch and run a public template with no account.

Set up another client Full quickstart

Fetch or fork

Fetch with CLI

goodeye templates get @randalolson/readme-generator

Fork with CLI

goodeye templates fork @randalolson/readme-generator

Also available from

MCP

get_template(identifier="@randalolson/readme-generator")

REST

curl https://api.goodeye.dev/v1/templates/@randalolson/readme-generator