XuqmGroup-RNSDK/README.md
XuqmGroup 3c7ae4d766 docs(deploy): 添加部署文档并更新SDK API设计规范
- 新增完整的XuqmGroup部署文档,包含服务器配置、Docker Compose部署策略
- 更新SDK API重设计规范至V2.0,统一各端SDK初始化和登录接口
- 添加安全设计规范文档,涵盖密码安全、AppSecret验证等内容
- 新增离线推送架构设计文档,定义厂商推送集成方案
- 重构SDK登录流程,统一使用userId + userSig鉴权模式
- 移除dbName等外部配置参数,实现零感知平台地址配置
- 完善部署架构图和配置示例文件
2026-05-02 11:29:50 +08:00

41 行
1.1 KiB
Markdown

# XuqmGroup React Native SDK
`rn-sdk` 的稳定入口是 `src/index.ts`,统一登录/登出层在 `src/sdk.ts`
旧的 `src/core`、`src/im`、`src/push`、`src/update` 目录已清理,避免继续引用废弃实现。
## 当前结构
```text
XuqmGroup-RNSDK/
├── src/
│ ├── index.ts # 对外聚合入口
│ └── sdk.ts # 统一登录 / 登出封装
├── packages/
│ ├── common/ # 初始化、网络、设备、Token、基础组件
│ ├── im/ # IM、会话、历史、群组、关系链
│ ├── push/ # 推送设备注册
│ └── update/ # App 更新 / RN 热更新
└── README.md
```
## 安装
```bash
yarn add @xuqm/rn-sdk
yarn add @react-native-async-storage/async-storage
# 如需按模块拆分接入,也可以直接安装
yarn add @xuqm/rn-common @xuqm/rn-im @xuqm/rn-push @xuqm/rn-update
```
## 入口
- `XuqmSDK.initialize({ appKey, logLevel })`
- `XuqmSDK.login({ userId, userSig })`
- `XuqmSDK.logout()`
- `ImSDK`
- `PushSDK`
- `UpdateSDK`
详细用法见 [docs/rn-sdk/README.md](../docs/rn-sdk/README.md)。