diff --git a/README.md b/README.md index ab1d82352..5d729d322 100644 --- a/README.md +++ b/README.md @@ -9,16 +9,198 @@ [](https://www.jetbrains.com/?from=WxJava-weixin-java-tools) [](https://opensource.org/licenses/Apache-2.0) -
+### 微信 `Java` 开发工具包,支持微信支付、开放平台、公众号、企业微信、视频号、小程序等后端开发。 + +--- + +### 目录 +- [快速开始(3分钟)](#快速开始3分钟) +- [我该选哪个模块?](#我该选哪个模块) +- [安装与版本](#安装与版本) +- [最小示例](#最小示例) +- [HTTP 客户端支持](#http-客户端支持) +- [FAQ(提问前必读)](#faq提问前必读) +- [社区与支持](#社区与支持) +- [贡献方式](#贡献方式) +- [版本说明](#版本说明) +- [应用案例](#应用案例) +- [赞助与致谢](#赞助与致谢) + +--- + +### 快速开始(3分钟) +1. 根据业务场景选择模块(见下方“我该选哪个模块?”) +2. 引入 Maven 依赖并使用最新稳定版本 +3. 参考最小示例初始化 `Service` 并调用 API + +--- + +### 我该选哪个模块? + +| 业务场景 | 模块 | artifactId | +|---|---|---| +| 微信公众号开发 | MP | `weixin-java-mp` | +| 微信小程序开发 | MiniApp | `weixin-java-miniapp` | +| 微信支付 | Pay | `weixin-java-pay` | +| 企业微信 | CP | `weixin-java-cp` | +| 微信开放平台(第三方平台) | Open | `weixin-java-open` | +| 视频号 / 微信小店 | Channel | `weixin-java-channel` | + +> 移动端(iOS/Android)微信登录、分享等能力仍需集成微信官方客户端 SDK;本项目为服务端 SDK。 + +--- + +### 安装与版本 + +最新版本(含测试版)请查看: +[](https://central.sonatype.com/artifact/com.github.binarywang/wx-java/versions) + +```xml +