Skip to content

Commit e35b330

Browse files
JackJiang2011JackJiang2011
committed
修订了说明文档
1 parent 236c0bf commit e35b330

File tree

1 file changed

+43
-42
lines changed

1 file changed

+43
-42
lines changed

‎README.md‎

Lines changed: 43 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,16 @@
33
<img src="preview/more_screenshots/others/github_header_logo_h_big2025.png" width="420" alt="MobileIMSDK logo">
44
</a>
55

6+
[![Gitee star](https://gitee.com/jackjiang/MobileIMSDK/badge/star.svg?theme=white)](https://gitee.com/jackjiang/MobileIMSDK)
67
[![GitHub stars](https://img.shields.io/github/stars/JackJiang2011/MobileIMSDK.svg?style=social&label=Stars)](https://github.com/JackJiang2011/MobileIMSDK)
7-
[![Gitee star](https://gitee.com/jackjiang/MobileIMSDK/badge/star.svg?theme=white)](https://gitee.com/jackjiang/MobileIMSDK/)
8-
[![GitHub Release](https://img.shields.io/github/v/release/JackJiang2011/MobileIMSDK?color=00c800&label=Latest%20Release)](https://github.com/JackJiang2011/MobileIMSDK/releases/latest)
98
[![License](https://img.shields.io/badge/license-Apache2.0-00c800)](https://gitee.com/JackJiang2011/MobileIMSDK/blob/master/LICENSE)
10-
9+
1110
[文档手册](http://www.52im.net/forum.php?mod=collection&action=view&ctid=1&fromop=all)・[技术社区](http://www.52im.net/forum-89-1.html)・[更新日志](http://www.52im.net/thread-1270-1-1.html)・[产品案例❶](http://www.52im.net/thread-20-1-1.html)・[产品案例❷](http://www.52im.net/thread-4824-1-1.html)・[产品案例❸](http://www.52im.net/thread-2470-1-1.html)
1211

1312

1413
<a href="http://www.52im.net/thread-52-1-1.html" target="_blank"><img src="https://trendshift.io/api/badge/repositories/3" alt="MobileIMSDK | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
1514

16-
:heart: <b>最新动态：</b>[鸿蒙Next端](https://github.com/JackJiang2011/MobileIMSDK/issues/34)已发布。基于MobileIMSDK的鸿蒙Next端IM产品[RainbowTalk](http://www.52im.net/thread-4822-1-1.html)已发布。 :heart:
15+
:heart: <b>最新动态：</b>[鸿蒙Next端](https://gitee.com/jackjiang/MobileIMSDK/issues/IBCI00)已发布。基于MobileIMSDK的鸿蒙Next端IM产品[RainbowTalk](http://www.52im.net/thread-4822-1-1.html)已发布。:heart:
1716

1817
</div>
1918

@@ -28,10 +27,11 @@
2827
* <b>❼ 🍀 产品案例2：</b> RainbowTalk产品（[详细介绍](http://www.52im.net/thread-4822-1-1.html)、[安装体验](http://www.52im.net/thread-4825-1-1.html)、[运行截图](http://www.52im.net/thread-4824-1-1.html) ） :point_left:
2928
* <b>❽ 🍀 产品案例3：</b>RainbowChat_Web产品（[详细介绍](http://www.52im.net/thread-2483-1-1.html)、[运行截图](http://www.52im.net/thread-2470-1-1.html) ） :point_left:
3029

30+
3131
# 二、项目简介
32-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/more_screenshots/others/github_header_logo_h2025.png)
32+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_screenshots/others/github_header_logo_h2025.png)
3333

34-
<b>MobileIMSDK是一套全平台原创IM通信层框架：</b>
34+
<b>MobileIMSDK是一套全平台IM通信层框架：</b>
3535
* 历经10年、久经考验；
3636
* 超轻量级、高度提炼，lib包50KB以内；
3737
* 精心封装，一套API优雅支持<b>UDP</b> 、<b>TCP</b> 、<b>WebSocket</b> 三种协议（可能是全网唯一开源的）；
@@ -45,25 +45,27 @@
4545
# 三、源码仓库同步更新
4646

4747
<b>当前源码仓库：</b>
48+
4849
* ❶ <b>GitHub：</b> [https://github.com/JackJiang2011/MobileIMSDK](https://github.com/JackJiang2011/MobileIMSDK)；
4950
* ❷ <b>码云gitee：</b> [http://git.oschina.net/jackjiang/MobileIMSDK](http://git.oschina.net/jackjiang/MobileIMSDK)；
50-
* ❸ <b>华为Gitcode：</b> [https://gitcode.com/hellojackjiang2011/MobileIMSDK](https://gitcode.com/hellojackjiang2011/MobileIMSDK)。
51+
* ❸ <b>Gitcode：</b> [https://gitcode.com/hellojackjiang2011/MobileIMSDK](https://gitcode.com/hellojackjiang2011/MobileIMSDK)。
5152

5253
<b>仓库文件目录：</b>
5354
| | 目录名 | 目录用途说明 |
5455
|---|--------------|----------------------------------------------------------------------|
55-
| 1 | 💎 `/demo_binary` | 🌟 内含编译好的Demo程序（含移动端和服务端），可直接安装到手机或电脑运行。|
56-
| 2 | 💎 `/demo_src` | 🌟 内含MobileIMSDK的所有Demo源码。 |
57-
| 3 | 💎 `/sdk_binary` | 🌟 内含编译好的MobileIMSDK核心库lib，可直接引用到自已的工程中。 |
58-
| 4 | 💎 `/sdk_src` | 🌟 内含MobileIMSDK核心库源码。 |
59-
| 5 | 💎 `/docs` | 🌟 内含API文档。 |
60-
| 6 | 💎 `/preview` | 🌟 内含Demo和产品案例的运行截图，供参考。 |
61-
| 7 | 💎 `/release_notes` | 🌟 内含历次版本更新日志（[也可从网页查看](http://www.52im.net/thread-1270-1-1.html)）。 |
56+
| 1 | 💎 [/demo_binary](https://gitee.com/jackjiang/MobileIMSDK/tree/master/demo_binary) | 🌟 内含编译好的Demo程序（含移动端和服务端），可直接安装到手机或电脑运行。|
57+
| 2 | 💎 [/demo_src](https://gitee.com/jackjiang/MobileIMSDK/tree/master/demo_src) | 🌟 内含MobileIMSDK的所有Demo源码。 |
58+
| 3 | 💎 [/sdk_binary](https://gitee.com/jackjiang/MobileIMSDK/tree/master/sdk_binary) | 🌟 内含编译好的MobileIMSDK核心库lib，可直接引用到自已的工程中。 |
59+
| 4 | 💎 [/sdk_src](https://gitee.com/jackjiang/MobileIMSDK/tree/master/sdk_src) | 🌟 内含MobileIMSDK核心库源码。 |
60+
| 5 | 💎 [/docs](https://gitee.com/jackjiang/MobileIMSDK/tree/master/docs) | 🌟 内含API文档。 |
61+
| 6 | 💎 [/preview](https://gitee.com/jackjiang/MobileIMSDK/tree/master/preview) | 🌟 内含Demo和产品案例的运行截图，供参考。 |
62+
| 7 | 💎 [/release_notes](https://gitee.com/jackjiang/MobileIMSDK/tree/master/release_notes) | 🌟 内含历次版本更新日志（[也可从网页查看](http://www.52im.net/thread-1270-1-1.html)）。 |
6263

6364
# 四、设计目标
6465
让开发者专注于应用逻辑的开发，底层<code>复杂的即时通讯算法交由SDK开发人员</code>，从而<code>解偶即时通讯应用开发的复杂性</code>。
6566

6667
# 五、框架组成
68+
6769
<b>整套MobileIMSDK框架由以下部分组成：</b>
6870

6971
| | 平台 | 完成度 | Demo演示 | 开发指南 | 源码位置 | 参考应用案例 |
@@ -80,7 +82,7 @@
8082

8183
<b>整套MobileIMSDK框架的架构原理图：</b>
8284

83-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/mibileimsdk_framework_2025.png)
85+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/mibileimsdk_framework_2025.png)
8486

8587
:bulb: <b>补充说明：</b>MobileIMSDK一直在持续开发和升级中，[鸿蒙Next客户端](http://www.52im.net/thread-4766-1-1.html) 是MobileIMSDK工程的最新成果。<b>另外：</b>MobileIMSDK可与姊妹工程 [MobileIMSDK-Web](http://www.52im.net/thread-959-1-1.html) 无缝互通，从而实现Web网页端聊天或推送等。
8688

@@ -112,19 +114,11 @@
112114
:point_right: 您可能需要：[查看更多关于MobileIMSDK的疑问及解答](http://www.52im.net/thread-60-1-1.html)。
113115

114116
# 七、性能测试
115-
压力测试表明，MobileIMSDK用于推送场景时，理论单机负载可接近千万级。用于聊天应用时，单机负载也可达数十万。（:point_right: 性能测试报告：[点此查看](http://www.52im.net/thread-57-1-1.html)）
117+
压力测试表明，MobileIMSDK用于推送场景时，理论单机负载可接近千万级。用于聊天应用时，单机负载也可达数十万（ :point_right: 性能测试报告：[点此查看](http://www.52im.net/thread-57-1-1.html)）。
116118

117119
> 当然，每款应用都有各自的特点和差异，请视具体场景具体评估之，测试数据仅供参考。
118120
119-
# 八、应用案例
120-
121-
| | 案例名 | 用途说明 | 详细介绍 | 安装体验 | 运行演示 |
122-
|---|-----------------|----|----|----|----|
123-
| 1 | **RainbowChat** | 产品级Android和iOS聊天APP| [点击查看](http://www.52im.net/thread-19-1-1.html) |[下载安装](http://www.52im.net/thread-4739-1-1.html) 🔥|[全功能截图](http://www.52im.net/thread-20-1-1.html)|
124-
| 2 | **RainbowChat-Web**| Web网页端产品级聊天系统| [点击查看](http://www.52im.net/thread-2483-1-1.html) |[运行视频](http://www.52im.net/thread-2491-1-1.html)|[全功能截图](http://www.52im.net/thread-2470-1-1.html)|
125-
| 3 | **RainbowTalk** ⭐️ | 纯血鸿蒙NEXT产品级聊天APP| [点击查看](http://www.52im.net/thread-4822-1-1.html) |[下载安装](http://www.52im.net/thread-4825-1-1.html) 🔥|[全功能截图](http://www.52im.net/thread-4824-1-1.html)|
126-
127-
# 九、典型应用场景
121+
# 八、典型应用场景
128122
### :triangular_flag_on_post: 场景1：聊天APP
129123
* <b>应用说明：</b>可用于开发类似于微信、QQ等聊天工具。<br>
130124
* <b>消息走向：</b>需使用C2C、C2S、S2C全部类型。<br>
@@ -142,6 +136,14 @@
142136
* <b>应用说明：</b>可用于实现企业OA中各种系统级、用户级消息的实时互动，充分利用即时通讯技术提升传统OA的价值。<br>
143137
* <b>消息走向：</b>可使用C2C、C2S、S2C全部类型，这与聊天APP在很多方面已无差别，但企业OA有自已的用户关系管理模型和逻辑，较之全功能聊天APP要简单的多。
144138

139+
# 九、应用案例
140+
141+
| | 案例名 | 用途说明 | 详细介绍 | 安装体验 | 运行演示 |
142+
|---|-----------------|----|----|----|----|
143+
| 1 | **RainbowChat** | 产品级Android和iOS聊天APP| [点击查看](http://www.52im.net/thread-19-1-1.html) |[下载安装](http://www.52im.net/thread-4739-1-1.html) 🔥|[全功能截图](http://www.52im.net/thread-20-1-1.html)|
144+
| 2 | **RainbowChat-Web**| Web网页端产品级聊天系统| [点击查看](http://www.52im.net/thread-2483-1-1.html) |[运行视频](http://www.52im.net/thread-2491-1-1.html)|[全功能截图](http://www.52im.net/thread-2470-1-1.html)|
145+
| 3 | **RainbowTalk** ⭐️ | 纯血鸿蒙NEXT产品级聊天APP| [点击查看](http://www.52im.net/thread-4822-1-1.html) |[下载安装](http://www.52im.net/thread-4825-1-1.html) 🔥|[全功能截图](http://www.52im.net/thread-4824-1-1.html)|
146+
145147
# 十、授权方式
146148
你可永久免费且自由地使用MobileIMSDK，如：用于研究、借鉴、甚至商业用途，但禁止在超越License约束内容的情况下用于商业用途等，请尊重知识产权。更详细的授权说明，请见[MobileIMSDK社区介绍贴](http://www.52im.net/thread-52-1-1.html)中的“十二、授权方式”一节。<b>如您还需获得更多技术支持或技术合作请联系作者。</b>
147149

@@ -154,9 +156,6 @@
154156
🔥 [技术和资料专区](http://www.52im.net/forum-89-1.html) ・
155157
[技术交流群](http://www.52im.net/portal.php?mod=topic&topicid=2) ・ [个人博客](http://www.52im.net/space-uid-1.html) ・ [Github主页](https://github.com/JackJiang2011) ・ [联系作者](http://www.52im.net/thread-2792-1-1.html) 🔥
156158

157-
我的公众号： :point_down: :point_down:
158-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/more_screenshots/others/my_mp_qr_400_b.png)
159-
160159
# 附录：Demo运行截图
161160
### 1、MobileIMSDK Demo在鸿蒙Next端运行效果：
162161
> <code>编译和运行：</code>[查看鸿蒙Next端Demo完整源码](https://gitee.com/jackjiang/MobileIMSDK/tree/master/demo_src/WebSocket/MobileIMSDK4HarmonyDemo)。
@@ -166,60 +165,62 @@
166165
### 2、MobileIMSDK Demo在Android端、iOS端运行效果：
167166
> <code>安装和使用：</code>[进入Android版Demo帮助页](http://www.52im.net/thread-55-1-1.html)、[进入iOS版Demo帮助页](http://www.52im.net/thread-54-1-1.html)。
168167
169-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/andriod_demo_main.png)
168+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/andriod_demo_main.png)
170169

171-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/ios_demo_main.png)
170+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/ios_demo_main.png)
172171

173172
### 3、MobileIMSDK Demo在H5端运行效果：
174173

175-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/h5_demo_main.png)
174+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/h5_demo_main.png)
176175

177176
### 4、MobileIMSDK Demo在微信小程序端运行效果：
178177

179-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/weixin_demo_main.png)
178+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/weixin_demo_main.png)
180179

181180
### 5、MobileIMSDK Demo在Uniapp端运行效果：
182181

183-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/uniapp_demo_main.png)
182+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/uniapp_demo_main.png)
184183

185184
### 6、MobileIMSDK Demo在Windows 运行效果：
186185
> <code>安装和使用：</code>[进入Java版Demo帮助页](http://www.52im.net/thread-56-1-1.html)。
187186
188-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/java_demo_main.png)
187+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/java_demo_main.png)
189188

190189
### 7、MobileIMSDK Demo在Mac OS X 运行效果：
191190
> <code>安装和使用：</code>[进入Java版Demo帮助页](http://www.52im.net/thread-56-1-1.html)。
192191
193-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/more_screenshots/others/mac_real_run.png)
192+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_screenshots/others/mac_real_run.png)
194193

195194
### 8、MobileIMSDK-Web版客户端Demo运行效果：
196195
> <code>1）MobileIMSDK-Web Demo在手机端浏览器运行效果：</code>[查看MobileIMSDK-Web版详情](http://www.52im.net/thread-959-1-1.html)。
197196
198-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/mibileimsdk_web_demo_on_mobile_browsers.jpg)
197+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/mibileimsdk_web_demo_on_mobile_browsers.jpg)
199198

200199
> <code>2）MobileIMSDK-Web Demo在PC端多种主流浏览器的运行效果：</code>[查看MobileIMSDK-Web版详情](http://www.52im.net/thread-959-1-1.html)。
201200
202-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/mibileimsdk_web_demo_on_pc_browsers.jpg)
201+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/mibileimsdk_web_demo_on_pc_browsers.jpg)
203202

204203
# 案例1：鸿蒙NEXT端IM产品RainbowTalk
205204
> <code>更多资料请见：</code>[详细介绍](http://www.52im.net/thread-4822-1-1.html)、[运行截图](http://www.52im.net/thread-4824-1-1.html)、[安装体验](http://www.52im.net/thread-4825-1-1.html)。
206205
207-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/more_products/rainbowtalk_0.jpg)
206+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/rainbowtalk_0.jpg?v=250816)
207+
208+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/rainbowtalk_4.jpg)
208209

209210
# 案例2：移动端IM产品RainbowChat
210-
> <code>关于RainbowChat产品的更多资料请见：</code>[详细介绍](http://www.52im.net/thread-19-1-1.html)、[运行截图](http://www.52im.net/thread-20-1-1.html)、[安装体验](http://www.52im.net/thread-4739-1-1.html)（真机实拍视频：[Andriod端](https://v.youku.com/v_show/id_XNTg4NDE2MjE1Mg==.html)、[iOS端](https://v.youku.com/v_show/id_XNDcwMDA4MDQwMA==.html)）。
211+
> <code>更多资料请见：</code>[详细介绍](http://www.52im.net/thread-19-1-1.html)、[运行截图](http://www.52im.net/thread-20-1-1.html)、[安装体验](http://www.52im.net/thread-4739-1-1.html)（真机实拍视频：[Andriod端](https://v.youku.com/v_show/id_XNTg4NDE2MjE1Mg==.html)、[iOS端](https://v.youku.com/v_show/id_XNDcwMDA4MDQwMA==.html)）。
211212
212-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/more_products/rainbowchat_2.jpg?v=10)
213+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/rainbowchat_2.jpg)
213214

214215
> <code>更多清晰运行截图请见：</code>[RainbowCha产品的全部功能截图](http://www.52im.net/thread-20-1-1.html)。
215216
216217
# 案例3：网页端IM产品RainbowChat-Web
217218
### :triangular_flag_on_post: RainbowChat-Web产品主界面：
218219
> <code>更多截图和视频：</code>[更多截图点此进入](http://www.52im.net/thread-2470-1-1.html)、[更多演示视频点此进入](http://www.52im.net/thread-2491-1-1.html)。
219220
220-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/more_products/rainbowchat_web/rbchat_web_main_1.jpg)
221+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/rainbowchat_web/rbchat_web_main_1.jpg)
221222

222223
### :triangular_flag_on_post: RainbowChat-Web产品主界面(独立UI效果)：
223224
> <code>更多截图和视频：</code>[更多截图点此进入](http://www.52im.net/thread-2470-1-1.html)、[更多演示视频点此进入](http://www.52im.net/thread-2491-1-1.html)。
224225
225-
![](http://jackimgs.52im.net/images/mobileimsdk/preview/more_products/rainbowchat_web/rbchat_web_main_0.jpg)
226+
![](https://gitee.com/jackjiang/MobileIMSDK/raw/master/preview/more_products/rainbowchat_web/rbchat_web_main_0.jpg)

0 commit comments

Comments
 (0)