Readme Maintainer

Overview

Maintain README.md as a code-adjacent artifact: grounded in the current repository state, clear for users, and safe from hallucinated commands. Use the active assistant model in this session; do not route through readme-ai provider APIs. Default to bilingual parity (English + Simplified Chinese) unless the user explicitly asks for single-language output.

Workflow

1. Resolve target repo path:

• Default to current working directory if user does not specify a path.
• Use explicit path if the user provides one.
• Confirm README.md destination (README.md by default).

2. Collect project facts:

• Run scripts/collect_repo_facts.sh <repo-path>.
• Read existing README.md first (if present), then read only relevant source/config files.
• Prefer authoritative files: package.json, pyproject.toml, go.mod, Cargo.toml, Makefile, and entrypoint modules.