docs: make README the complete project integration entry point

2026-09-23 21:10:43 +08:00
parent 35bd724326
commit 7b8eca1a61
5 changed files with 330 additions and 259 deletions
--- a/API.md
+++ b/API.md
@@ -1,5 +1,7 @@
 # API 契约与项目生成

+首次接入请先看 [README](README.md)：包含固定远程版本安装、可运行项目、完整 `.api` 示例和已有服务接入步骤。本页用于查阅语法与生成规则；下方带 `--framework-dir` 的命令用于框架源码开发。
+
 本阶段目标：从 `.api` 定义生成可运行的 Go 项目；定义、绑定、校验与 OpenAPI 保持一致；重复生成不覆盖业务实现；业务代码继续独立于网络层。实现入口是 `cmd/go-omni/apigen`，运行时契约编译器是 `contract`。

 ## 与 go-zero 的对应关系