From 1e2158e2631cb62fe8c29dfe40ce61301cf0b8c1 Mon Sep 17 00:00:00 2001
From: liuhuapiaoyuan <278780765@qq.com>
Date: Sun, 29 Dec 2024 12:16:20 +0800
Subject: [PATCH] =?UTF-8?q?doc(wechatmp-kit):=20=E6=9B=B4=E6=96=B0?=
 =?UTF-8?q?=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 packages/wechatmp-kit/README.MD    | 123 +++++++++++++++++++++++++++--
 packages/wechatmp-kit/package.json |   4 +-
 2 files changed, 118 insertions(+), 9 deletions(-)

diff --git a/packages/wechatmp-kit/README.MD b/packages/wechatmp-kit/README.MD
index 8c906d8..34b0abe 100644
--- a/packages/wechatmp-kit/README.MD
+++ b/packages/wechatmp-kit/README.MD
@@ -1,9 +1,118 @@
-## 微信公众号开发工具
+# 🎉 微信公众号开发工具包 🛠️
 
-> 不知道为啥全网找不到一个合适的微信公众号开发工具,所以就有了这个工具
+一个基于TypeScript的微信公众号开发工具包，提供核心API接口和实用工具。
 
-- 消息报送: 发送文本、图片、语音、视频、图文等消息
-- 消息接收
-- 接口： 获取token、token缓存
-- 用户接口： 获得用户列表、按标签获得用户列表
-- 标签接口： 获得标签列表、创建标签、修改标签、删除标签
+## 🚀 核心功能
+
+- 🔑 **Access Token管理**
+  - ✅ 自动获取和缓存Access Token
+  - 🛠️ 支持自定义Token缓存实现
+- 📨 **消息处理**
+  - 📝 XML消息解析与生成
+  - 📦 消息服务封装
+- 👤 **用户管理**
+  - 🛠️ 提供用户服务接口
+- 🌐 **通用请求**
+  - 📡 封装微信API请求
+
+## 📦 安装
+
+```bash
+npm install wechatmp-kit
+# 或者
+yarn add wechatmp-kit
+```
+
+## ⚡ 快速开始
+
+### 初始化
+
+```typescript
+import { WechatMpApi } from 'wechatmp-kit'
+
+const wechatApi = new WechatMpApi({
+  appId: '你的应用ID',
+  appSecret: '你的应用密钥',
+})
+```
+
+### 获取Access Token
+
+```typescript
+const token = await wechatApi.getAccessToken()
+console.log('Access Token:', token)
+```
+
+### 处理消息
+
+```typescript
+const messageService = wechatApi.getMessageService('your-token')
+const parsedMessage = messageService.parseXML(xmlMessage)
+```
+
+### 使用用户服务 👤
+
+```typescript
+const userService = wechatApi.userService
+
+// 获取用户列表
+const userList = await userService.userGet()
+
+// 按标签获取用户
+const taggedUsers = await userService.userTagGet(tagId)
+
+// 获取所有标签
+const tags = await userService.tagsGet()
+
+// 发送模板消息
+await userService.messageTemplateSend({
+  touser: openId,
+  template_id: 'TEMPLATE_ID',
+  data: {
+    key1: { value: '内容1' },
+    key2: { value: '内容2' },
+  },
+})
+```
+
+## 📚 API 参考
+
+### WechatMpApi
+
+#### 构造函数
+
+```typescript
+new WechatMpApi(options: {
+  appId: string
+  appSecret: string
+  tokenCache?: WehcatMpAccessTokenCacheManager
+})
+```
+
+#### 主要方法
+
+- `getAccessToken()`: 获取当前Access Token
+- `getMessageService(token: string, encodingAESKey?: string)`: 获取消息处理服务
+- `request<T>(options: RequestOptions)`: 发送微信API请求
+
+### WehcatMpAccessTokenCacheManager
+
+Token缓存管理接口，默认提供内存缓存实现。
+
+#### 方法
+
+- `get(appId: string)`: 获取缓存Token
+- `set(appId: string, value: AccessTokenApiResult)`: 设置缓存Token
+
+## 工具函数
+
+- `parseWehcatMessageXML<T>(xml: string)`: 解析微信XML消息
+- `renderXML(data: Record<string, string | number | object>)`: 生成XML消息
+
+## 🤝 贡献指南
+
+欢迎提交Pull Request。请确保代码风格一致并通过所有测试。
+
+## 📜 许可证
+
+本项目采用 MIT 许可证。
diff --git a/packages/wechatmp-kit/package.json b/packages/wechatmp-kit/package.json
index 8b12dce..d366fe4 100644
--- a/packages/wechatmp-kit/package.json
+++ b/packages/wechatmp-kit/package.json
@@ -1,6 +1,6 @@
 {
   "name": "wechatmp-kit",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "微信公众号工具包",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -30,4 +30,4 @@
   "license": "MIC",
   "peerDependencies": {},
   "devDependencies": {}
-}
+}
\ No newline at end of file