From a7afe895b5a896cbb93ed39456bafd16aecb4a24 Mon Sep 17 00:00:00 2001
From: Leon <147289645+LeoninCS@users.noreply.github.com>
Date: Fri, 5 Dec 2025 10:15:02 +0800
Subject: [PATCH] docs: improve readme.md

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

diff --git a/README.md b/README.md
index 30adb00..6540ae8 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,34 @@
 # feedsystem_video_go
-# 项目介绍
-一款基于go语言的视频feed流系统。
-# 文件介绍
-start.sh 为启动脚本
-postman.json 为postman的请求集合文件
-其余均为项目文件。
\ No newline at end of file
+
+## 项目简介
+一款基于Go语言的视频feed流系统。
+
+## 目录结构
+1. `cmd/`：程序入口（`main.go`）。
+2. `configs/`：YAML 配置文件（`config.yaml`）。  
+3. `internal/`：核心逻辑  
+   - `account/` 账号模型、仓储、服务  
+   - `config/` YAML 配置加载  
+   - `db/` MySQL 连接与迁移  
+   - `http/` Gin 路由与 handler  
+4. `test/`：Postman Collection（`account.json`）  
+5. `start.sh`：自定义启动脚本  
+
+## 快速开始
+1. 准备 Go 1.24+、MySQL 8+ 环境。  
+2. 创建 `feedsystem` 数据库，按需修改 `configs/config.yaml`。  
+3. 安装依赖：`go mod tidy`。  
+4. 启动服务：`go run ./cmd`（或 `sh start.sh`）。  
+5. 导入 `test/account.json`，设置 `host=http://localhost:8080` 可快速调接口。  
+
+## API
+| 方法 | 路径 | 说明 |
+|------|------|------|
+| POST | `/user/register` | `username`,`password` 创建用户 |
+| POST | `/user/rename` | `id`,`new_username` 修改用户名 |
+| POST | `/user/changePassword` | `id`,`new_password` 修改密码 |
+| POST | `/user/findByID` | `id` 查询用户 |
+| POST | `/user/findByUsername` | `username` 查询用户 |
+
+- 接口统一使用 JSON 请求/响应。  
+- 启动时自动执行 `db.AutoMigrate`，保持用户表结构一致。