From 42d319158b34cee4a1b979baf2f4460bac6a1a87 Mon Sep 17 00:00:00 2001
From: qloog <quanlongwang@gmail.com>
Date: Tue, 11 Feb 2025 17:22:53 +0800
Subject: [PATCH] docs: add dir desc

---
 README.md | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/README.md b/README.md
index 3e24156..0cbcc3e 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,39 @@ eagle project template
 
 eagle: https://github.com/go-eagle/eagle
 
+## 目录结构
+
+```bash
+.
+├── api                          # proto协议定义目录
+├── cmd                          # 项目主要的入口文件目录
+│   ├── consumer                 # 消费者服务入口
+│   ├── gen                      # 代码生成工具入口 
+│   └── server                   # HTTP/GRPC 服务主入口
+├── config                       # 配置文件目录
+│   ├── dev                      # 开发环境配置
+│   ├── test                     # 测试环境配置
+│   ├── prod                     # 生产环境配置
+│   └── docker                   # Docker 环境配置
+├── deploy                       # 部署相关配置
+│   ├── docker                   # Docker 部署配置
+│   └── k8s                      # Kubernetes 部署配置
+├── internal                     # 内部应用程序代码
+│   ├── dal                      # 数据访问层
+│   │   ├── cache               # 缓存操作
+│   │   ├── db                  # 数据库操作
+│   │   └── rpc                 # RPC 调用
+│   ├── ecode                   # 错误码定义
+│   ├── event                   # 事件处理
+│   │   └── subscribe           # 消息订阅处理
+│   ├── handler                 # HTTP 请求处理器
+│   ├── repository             # 数据仓库层
+│   ├── routers                # 路由定义
+│   └── service                # 业务逻辑层
+├── scripts                    # 存放shell脚本
+└── third_party                # 三方proto文件
+```
+
 ## 开发流程
 
 1、修改 proto