Skip to content

📚 docs(readme): 规范项目首屏与演示入口 - #141

Merged
ZhaoXingPeng merged 1 commit into
mainfrom
docs/readme-release-polish
Sep 11, 2026
Merged

ZhaoXingPeng merged 1 commit into
mainfrom
docs/readme-release-polish

Conversation

@ZhaoXingPeng

Copy link
Copy Markdown
Owner

关联 Issue

Closes #140

做了什么

  • 为项目 README 增加明确的文字版标题:BabelFlux Java / 巴别流同传。
  • 将首屏调整为标题、项目定位、CI/Release/Maven/许可证徽章和单一 Demo 视频链接。
  • 移除 Demo 区的主图预览及重复链接,避免把主图误作可运行 Demo。
  • 保留后续架构图和功能文档,技术细节与 v0.1.1 发布状态保持一致。

实验与结果

实验:检查 README 首屏结构、Demo 链接、徽章链接和发布信息,并运行 git diff --check。
结果:项目名称在首屏以 Markdown 标题显示;Demo 区仅保留一个 Bilibili 链接;徽章分别指向 Quality Gates、Release、GitHub Packages 和 LICENSE;差异检查通过。
结论:项目 README 具备可识别的名称、单一演示入口和可验证的发布状态,不再使用主图作为 Demo 占位。

风险与回滚

仅修改根目录 README,不影响源码、构建、发布工作流或运行时行为;如需回滚,反转本 PR 的单个文档提交即可。

提交前检查

@ZhaoXingPeng
ZhaoXingPeng merged commit e1e0a49 into main Sep 11, 2026
3 checks passed
@ZhaoXingPeng
ZhaoXingPeng deleted the docs/readme-release-polish branch September 11, 2026 01:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

📚 docs(readme): 规范项目与主页首屏发布信息

1 participant