From 3d9c7a2b2869135254d06edb310b4dadc563a841 Mon Sep 17 00:00:00 2001
From: loren <loren@langcore.cn>
Date: Thu, 29 Jan 2026 15:44:24 +0800
Subject: [PATCH] docs:update

---
 .gitignore | 28 +++++++++++++++++++++
 README.md  | 72 +++++++++++++++++++++++++++++++++++++-----------------
 2 files changed, 78 insertions(+), 22 deletions(-)
 create mode 100644 .gitignore

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..ffbc1b4
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,28 @@
+//重要信息，依赖
+node_modules/
+.env
+.env.local
+.env.backup
+.env.development.local
+.env.test.local
+.env.production.local
+
+//其余忽略规则
+logs/
+.DS_Store
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log
+lerna-debug.log*
+dist/
+build/
+coverage/
+logs/
+*.log
+.idea/
+.vscode/
+.cache/
+sync_database.sqlite
+
+//暂时忽略
+app.js
\ No newline at end of file
diff --git a/README.md b/README.md
index f5ef4cf..39b2a11 100644
--- a/README.md
+++ b/README.md
@@ -16,11 +16,11 @@ npm install
 ```
 
 该命令将安装以下依赖:
-- express (5.x): Web框架和HTTP服务器
+- hono (4.x): 轻量级Web框架
+- @hono/node-server (1.x): Hono Node.js服务器适配器
 - axios (1.13.x): HTTP客户端库
-- better-sqlite3 (9.x): SQLite数据库驱动
+- better-sqlite3 (12.x): SQLite数据库驱动
 - dotenv (17.x): 环境变量加载
-- express-rate-limit (8.x): 速率限制中间件
 - j2m (1.1.x): Markdown与Jira格式转换库
 
 ### 第二步：环境变量配置
@@ -344,24 +344,52 @@ DEBUG模式下:
 - 内存锁防止重复处理同一工单
 
 ## 代码结构
+
 ```
-src/
-  config/          - 配置文件
-    env.js         - 环境变量加载
-    mappings.js    - 字段映射配置
-  db/              - 数据库相关
-    connection.js  - 数据库连接
-    issueMap.js    - 映射表操作
-  logic/           - 业务逻辑
-    converter.js   - 数据转换
-    syncManager.js - Gitea->Jira同步
-    jiraSyncManager.js - Jira->Gitea同步
-  services/        - API服务
-    gitea.js       - Gitea API客户端
-    jira.js        - Jira API客户端
-  utils/           - 工具函数
-    logger.js      - 日志模块
-    circuitBreaker.js - 熔断器
-index.js           - 主程序
-mappings.json      -映射表
+gitea-jira-sync/
+├── index.js                    - 主程序（Hono应用入口）
+├── mappings.json               - 映射配置文件
+├── package.json                - 项目依赖配置
+├── README.md                   - 本文档
+├── how-to-use.md               - 使用指南
+├── data/                        - 数据目录
+├── logs/                        - 日志目录
+├── public/                      - 前端资源目录
+│   ├── app.js                  - 配置编辑器应用脚本
+│   ├── dashboard-app.js        - 仪表板应用脚本
+│   ├── dashboard.html          - 仪表板页面
+│   ├── editor.html             - 配置编辑器页面
+│   └── error.html              - 错误页面
+└── src/
+    ├── config/                 - 配置模块
+    │   ├── env.js              - 环境变量加载
+    │   └── mappings.js         - 字段映射配置管理
+    ├── db/                     - 数据库模块
+    │   ├── connection.js       - 数据库连接管理
+    │   └── issueMap.js         - 工单映射表操作
+    ├── logic/                  - 业务逻辑模块
+    │   ├── converter.js        - 字段数据转换
+    │   ├── syncManager.js      - Gitea->Jira同步管理
+    │   └── jiraSyncManager.js  - Jira->Gitea同步管理
+    ├── routes/                 - 路由模块
+    │   └── editor.js           - 配置编辑器路由
+    ├── services/               - 第三方API服务
+    │   ├── gitea.js            - Gitea API客户端
+    │   └── jira.js             - Jira API客户端
+    └── utils/                  - 工具函数
+        ├── logger.js           - 日志模块
+        ├── circuitBreaker.js   - 熔断器实现
+        └── tests_created_by_claude/
+            ├── cleanup-test-issues.js
+            └── comprehensive-test.js
 ```
+
+## 技术栈
+
+- **Web框架**: Hono 4.x（轻量级、高性能）
+- **服务器**: Node.js + @hono/node-server
+- **数据库**: SQLite 3.x（better-sqlite3驱动）
+- **HTTP客户端**: Axios
+- **环境管理**: dotenv
+- **格式转换**: j2m（Markdown↔Jira格式）
+- **前端**: Vanilla JS（无框架依赖）