From e6981ecf361de2c7bea66905eaa236be7fc295c6 Mon Sep 17 00:00:00 2001
From: gitee-bot <no-reply@git.oschina.net>
Date: Wed, 10 Sep 2025 06:46:47 +0000
Subject: [PATCH] Add README.md

---
 README.en.md | 92 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.md    | 92 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 184 insertions(+)
 create mode 100644 README.en.md
 create mode 100644 README.md

diff --git a/README.en.md b/README.en.md
new file mode 100644
index 0000000..bff7ba1
--- /dev/null
+++ b/README.en.md
@@ -0,0 +1,92 @@
+# File Backup Client
+
+This is an Electron-based file backup client application that provides secure and reliable file transfer task management functionality.
+
+## Features
+
+📁 **Task Type Support**  
+🎯 **Task Priority Management**  
+📊 **Task Status Management** (Pending/In Progress/Completed/Paused)  
+⚡ **Task Control Functions** (Start/Pause/Cancel)  
+📈 **Real-time Progress Monitoring**  
+🔍 **Task Query and Filtering**
+
+## System Architecture
+
+### Technology Stack
+- Frontend Framework: Vue 3 + Vite
+- Desktop Application: Electron
+- Database: SQLite
+- State Management: Vuex
+- Routing: Vue Router
+- Styling Framework: Tailwind CSS
+
+### Core Modules
+- **Task Manager**: Supports upload task management for folders and files
+- **Database Operations**: Provides persistent storage for task data
+- **File Encryption**: AES encryption algorithm ensures data security
+- **Network Requests**: Encapsulates encrypted communication protocol
+- **IPC Communication**: Data interaction between main and renderer processes
+
+## Usage Instructions
+
+### Launching the Application
+```bash
+npm run dev
+```
+
+### Creating a Task
+Supports creating upload tasks for individual files or entire folders
+
+### Task Operations
+- Start a task
+- Pause a task
+- View sub-task details
+- Delete a task
+
+### Task Monitoring
+- View real-time task progress
+- View task statistics
+
+## Technical Implementation
+
+### Core Components
+- `FileTransferManager`: Handles file transfer logic
+- `TaskManager`: Manages task lifecycle
+- `FileCryptManager`: Handles file encryption and decryption
+- `ConfigManager`: Manages application configurations
+
+### Security Features
+- AES-256 file encryption
+- Secure key management
+- HTTPS network communication
+
+## Contribution Guide
+
+Welcome to participate in project development:
+1. Fork the repository
+2. Create a new branch
+3. Submit a Pull Request
+
+Please follow the project's coding standards, keep the code clean, and maintain complete documentation.
+
+## Troubleshooting
+
+### Common Issues
+- **Database connection failure**: Check database file path and permissions
+- **Task creation failure**: Confirm file path validity
+- **Page fails to load**: Check network connection and server status
+
+### Debugging Methods
+Use Chrome DevTools for frontend debugging  
+Check application runtime status via log files
+
+## Future Enhancements
+
+### Planned Features
+- Add support for download tasks
+- Improve UI/UX design
+- Add more task filtering and sorting options
+- Implement resume from breakpoint functionality
+
+This project aims to provide a secure, reliable, and user-friendly file backup solution. Community contributions and feedback are welcome.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d04e2bc
--- /dev/null
+++ b/README.md
@@ -0,0 +1,92 @@
+# 文件备份客户端
+
+这是一个基于 Electron 的文件备份客户端应用，提供安全可靠的文件传输任务管理功能。
+
+## 功能特性
+
+📁 **任务类型支持**  
+🎯 **任务优先级管理**  
+📊 **任务状态管理**（待处理/进行中/已完成/已暂停）  
+⚡ **任务控制功能**（启动/暂停/取消）  
+📈 **实时进度监控**  
+🔍 **任务查询与筛选**
+
+## 系统架构
+
+### 技术栈
+- 前端框架：Vue 3 + Vite
+- 桌面应用：Electron
+- 数据库：SQLite
+- 状态管理：Vuex
+- 路由管理：Vue Router
+- 样式框架：Tailwind CSS
+
+### 核心模块
+- **任务管理器**：支持文件夹和文件的上传任务管理
+- **数据库操作**：提供任务数据持久化存储
+- **文件加密**：AES 加密算法保障数据安全
+- **网络请求**：封装加密通信协议
+- **IPC 通信**：主进程与渲染进程间数据交互
+
+## 使用说明
+
+### 启动应用
+```bash
+npm run dev
+```
+
+### 创建任务
+支持创建单个文件或整个文件夹的上传任务
+
+### 任务操作
+- 启动任务
+- 暂停任务
+- 查看子任务详情
+- 删除任务
+
+### 任务监控
+- 实时查看任务进度
+- 查看任务统计信息
+
+## 技术实现
+
+### 核心组件
+- `FileTransferManager`：处理文件传输逻辑
+- `TaskManager`：管理任务生命周期
+- `FileCryptManager`：处理文件加密解密
+- `ConfigManager`：管理应用配置
+
+### 安全特性
+- AES-256 文件加密
+- 安全的密钥管理
+- HTTPS 网络通信
+
+## 贡献指南
+
+欢迎参与项目开发：
+1. Fork 仓库
+2. 创建新分支
+3. 提交 Pull Request
+
+请遵循项目代码规范，保持代码整洁和文档完整。
+
+## 故障排除
+
+### 常见问题
+- **数据库连接失败**：检查数据库文件路径和权限
+- **任务创建失败**：确认文件路径有效性
+- **页面无法加载**：检查网络连接和服务器状态
+
+### 调试方法
+使用 Chrome DevTools 进行前端调试
+通过日志文件查看应用运行状态
+
+## 扩展功能
+
+### 后续开发计划
+- 增加下载任务支持
+- 改进 UI/UX 设计
+- 增加更多任务过滤和排序选项
+- 实现断点续传功能
+
+本项目旨在提供一个安全、可靠、易用的文件备份解决方案，欢迎社区贡献和反馈建议。
\ No newline at end of file
-- 
Gitee