ShipReadme

项目目标

ShipReadme 面向开源项目作者、独立开发者和 side project 维护者。用户输入一个公开 GitHub 仓库地址后，系统读取仓库结构和关键文件，判断 README 是否清楚、可信、可运行，并输出一份证据驱动的健康报告和改进版 README 草案。

MVP 版本坚持做一个小而精准的发布前体检工具：

• 不做登录和 GitHub OAuth
• 不分析私有仓库
• 不自动创建 PR
• 不做团队协作和长期监控
• 不强依赖 AI，第一版优先使用规则引擎和模板生成
• 每条建议都必须来自真实仓库文件证据

技术路径

Next.js App Router
  -> 用户输入公开 GitHub 仓库 URL
  -> GitHub REST API 读取默认分支文件树
  -> 识别 README、依赖清单、Docker、环境变量、LICENSE、CI、测试和截图信号
  -> 规则引擎生成 README Readiness Score
  -> 输出 evidence、修复计划和可复制 Markdown 草案

核心诊断维度包括 Quick Start、Configuration、Testing、Deployment、License、Contributing 和 Screenshots / Demo。生成内容遵循“不编造不存在的命令”原则：如果仓库没有检测到测试脚本，就不会写虚假的测试命令；如果没有 Dockerfile，就不会写 Docker 部署步骤。

部署边界

ShipReadme 当前以 Docker 方式自部署，通过 nginx 暴露独立子域名：

https://shipreadme.adong.org.cn

生产环境只分析公开 GitHub 仓库，不保存用户账号，不接入 OAuth。可选配置 GITHUB_TOKEN 仅用于提升 GitHub API 速率限制，并且只需要公开仓库读取能力。