From 907ddd6696658b9a455ed1050e6fe6db579e191c Mon Sep 17 00:00:00 2001
From: gitee-bot <no-reply@git.oschina.net>
Date: Mon, 28 Jul 2025 14:54:48 +0000
Subject: [PATCH] Update README.md

---
 README.md | 108 ++++++++++++++++++++++++++++++++++++++----------------
 1 file changed, 77 insertions(+), 31 deletions(-)

diff --git a/README.md b/README.md
index 47cec63..bff8323 100644
--- a/README.md
+++ b/README.md
@@ -1,39 +1,85 @@
-# mail-solon-plugin
 
-#### 介绍
-solon邮件插件
 
-#### pom配置
+mail-solon-plugin 是一个基于 Solon 框架的轻量级邮件发送插件，适用于需要在 Java 应用中快速集成邮件发送功能的场景。
 
-1.  在pom.xml文件配置仓库属性
-```
-    <repositories>
-        <repository>
-            <id>epay-sdk</id>
-            <url>https://gitee.com/gitwcx/mail-solon-plugin/raw/master/release/</url>
-        </repository>
-    </repositories>
+## 介绍
+
+该插件封装了常见的邮件发送操作，支持发送简单文本邮件和 HTML 格式邮件，并通过配置类简化了邮件服务的设置。
+
+## 配置
+
+插件使用 `MailProperties` 类进行配置，支持以下属性：
+
+- `host`: 邮件服务器主机地址
+- `port`: 邮件服务器端口
+- `username`: 发送邮件的用户名
+- `password`: 发送邮件的密码
+- `ssl`: 是否启用 SSL 加密
+- `encoding`: 邮件编码格式
+- `from`: 默认发件人邮箱
+
+这些配置项可以通过配置文件进行设置，例如 `application.yml` 或 `app.yml`。
+
+## 使用说明
+
+### Maven 配置
+
+在 `pom.xml` 中添加插件依赖：
+
+```xml
+<dependency>
+    <groupId>com.walter</groupId>
+    <artifactId>mail-solon-plugin</artifactId>
+    <version>1.0.7</version>
+</dependency>
 ```
-2.  引入sdk依赖版本
+
+### 示例代码
+
+1. **发送简单文本邮件**
+
+```java
+mailService.sendSimpleMail("recipient@example.com", "邮件主题", "邮件内容");
 ```
-    <dependency>
-        <groupId>com.walter</groupId>
-        <artifactId>mail-solon-plugin</artifactId>
-        <version>${last-version}</version>
-    </dependency>
+
+2. **发送 HTML 格式邮件**
+
+```java
+String htmlContent = "<h1>HTML 内容</h1><p>这是一封 HTML 邮件</p>";
+mailService.sendHtmlMail("recipient@example.com", "邮件主题", htmlContent);
 ```
 
-3. 配置，在app.yml中添加以下配置
-```yml
-solon.mail:
-  host: smtp.qq.com
-  port: 465
-  username: username # 邮箱账号
-  password: password # 邮箱密码
-  ssl: true
-  encoding: UTF-8
-  from: from
+### 配置文件示例 (application.yml)
+
+```yaml
+solon:
+  mail:
+    host: smtp.example.com
+    port: 587
+    username: your-username
+    password: your-password
+    ssl: true
+    encoding: UTF-8
+    from: no-reply@example.com
 ```
-4. 修改最新依赖版本,依赖版本可[点击](https://gitee.com/gitwcx/mail-solon-plugin/tree/master/release/com/walter/mail-solon-plugin)查看
-### 使用说明
-- 具体可以参考[测试方法](https://gitee.com/gitwcx/mail-solon-plugin/blob/master/src/test/java/com/walter/integration/MailServiceTest.java)
\ No newline at end of file
+
+## 插件启动
+
+插件通过 `MailPlugin` 类实现 `Plugin` 接口，并在 `start` 方法中进行初始化，确保插件可以在 Solon 应用中顺利加载。
+
+## 注意事项
+
+- 请确保邮件服务器的配置信息正确，避免发送邮件失败。
+- 依赖的邮件库为 Jakarta Mail，版本为 2.0.1。
+
+## 版本信息
+
+当前版本为 1.0.7，已发布至 Gitee Maven 仓库，可直接引用使用。
+
+## 贡献和反馈
+
+欢迎通过 Gitee 仓库提交 issue 或 PR 进行插件改进和优化。
+
+## 协议
+
+本项目采用 MIT 协议，请在使用时遵守相关条款。
\ No newline at end of file
-- 
Gitee