From 790943154bf10e22ede44a1dcac1e488f589adc2 Mon Sep 17 00:00:00 2001
From: gitee-bot <no-reply@git.oschina.net>
Date: Mon, 22 Dec 2025 06:53:08 +0000
Subject: [PATCH] Add README.md

---
 README.en.md | 36 ++++++++++++++++++++++++++++++++++++
 README.md    | 40 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 76 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..46962ac
--- /dev/null
+++ b/README.en.md
@@ -0,0 +1,36 @@
+# RuoYi-Plus-MT
+
+RuoYi-Plus-MT is an enhanced tool based on the RuoYi project, primarily designed for batch renaming and configuration updates. It supports functionalities such as directory structure renaming, file content replacement, and data source configuration updates, making it suitable for project migration or refactoring scenarios.
+
+## Features
+
+- **Project Renaming**: Supports comprehensive renaming of the project directory structure.
+- **File Content Replacement**: Automatically replaces package names, data source configurations, and other related content within the project.
+- **Data Source Configuration Update**: Supports updating database connection information, including host, port, username, password, and database name.
+- **Author Information Update**: Supports updating author information within the project.
+- **Backup Mechanism**: Provides a backup feature before renaming to ensure operational safety.
+
+## Main Components
+
+- `RuoYiCloudPlusRenameToolV2`: Core tool class providing project renaming and configuration update functionality.
+- `CommonUtil`: Utility class containing auxiliary methods for directory operations, string processing, etc.
+- `Test`: Test class used to verify tool functionality.
+
+## Usage Instructions
+
+1. **Configure Parameters**: Set the project path, new name, new package name, and data source information via the `RuoYiCloudPlusRenameToolV2.RenameConfig` class.
+2. **Execute Renaming**: Call the `renameProject()` or `renameProjectWithBackup()` method to perform the project renaming operation.
+3. **Verify Results**: Check whether the project directory structure and file contents have been correctly updated.
+
+## Notes
+
+- Ensure you back up your project before performing the renaming operation to prevent accidental data loss.
+- The tool excludes specific directories and file extensions by default; to modify exclusion rules, adjust the `EXCLUDE_DIRS` and `EXCLUDE_FILE_EXTENSIONS` sets.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+---
+
+For further details on the implementation, please refer to the source code files.
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1d811ce
--- /dev/null
+++ b/README.md
@@ -0,0 +1,40 @@
+根据项目结构和代码映射信息，以下是适用于该项目的 README.md 内容：
+
+---
+
+# RuoYi-Plus-MT
+
+RuoYi-Plus-MT 是一个基于 RuoYi 项目的增强工具，主要用于对项目进行批量重命名和配置更新操作。该工具支持目录结构重命名、文件内容替换以及数据源配置更新等功能，适用于项目迁移或重构场景。
+
+## 功能特性
+
+- **项目重命名**：支持对项目目录结构进行整体重命名。
+- **文件内容替换**：自动替换项目中涉及的包名、数据源配置等内容。
+- **数据源配置更新**：支持更新数据库连接信息，包括主机、端口、用户名、密码及数据库名称等。
+- **作者信息更新**：支持更新项目中的作者信息。
+- **备份机制**：提供项目重命名前的备份功能，确保操作安全。
+
+## 主要组件
+
+- `RuoYiCloudPlusRenameToolV2`：核心工具类，提供项目重命名和配置更新功能。
+- `CommonUtil`：通用工具类，包含目录操作、字符串处理等辅助方法。
+- `Test`：测试类，用于验证工具功能。
+
+## 使用说明
+
+1. **配置参数**：通过 `RuoYiCloudPlusRenameToolV2.RenameConfig` 类设置项目路径、新名称、新包名及数据源信息等。
+2. **执行重命名**：调用 `renameProject()` 或 `renameProjectWithBackup()` 方法进行项目重命名操作。
+3. **验证结果**：检查项目目录结构及文件内容是否已正确更新。
+
+## 注意事项
+
+- 请确保在执行重命名操作前备份项目，以防止意外数据丢失。
+- 工具默认排除特定目录和文件扩展名，如需修改排除规则，请调整 `EXCLUDE_DIRS` 和 `EXCLUDE_FILE_EXTENSIONS` 集合。
+
+## 许可证
+
+本项目遵循 MIT 许可证，请参阅 [LICENSE](LICENSE) 文件获取详细信息。
+
+--- 
+
+如需进一步了解代码实现细节，请查看源码文件。
\ No newline at end of file
-- 
Gitee