README Wizard

Generate or improve a project's README by scanning the repo and producing a polished, professional result based on real project data.

Workflow

1. Scan the project

Run scripts/scan_project.sh <project-directory> to collect structured JSON metadata:

• Project name and description
• License type
• Git remote (owner and repo name)
• Package manager (npm, yarn, pnpm, pip, cargo, go, etc.)
• CI setup (provider and workflow files)
• Social links (YouTube, Discord, Twitter, LinkedIn, Bluesky, Twitch)
• Directory structure (top 2 levels)

The reference script checks local files first, then uses the GitHub API to look up the homepage URL and crawls that homepage for additional social links. Your own first version can stay local-file only and add this enrichment later if you want it.