添加介绍
This commit is contained in:
parent
5f5c05fd95
commit
6c8e4ca788
21
README.md
21
README.md
|
|
@ -2,8 +2,23 @@
|
|||
|
||||
项目源自:[weapp.socket.io](https://github.com/10cella/weapp.socket.io),该项目作者已经两年没有维护,出现bug无法修复。
|
||||
|
||||
最近需要在uni-app中用到socket.io,遇到bug没有人修复,所以基于weapp.socket.io新起一个项目。
|
||||
最近需要在uni-app中用到socket.io,遇到bug没有人修复很是头疼,所以基于weapp.socket.io新起一个项目。
|
||||
|
||||
## 使用
|
||||
### 介绍
|
||||
|
||||
参考[weapp.socket.io](https://github.com/10cella/weapp.socket.io)
|
||||
重写socket.io-client的engin.io-client处理件,h5依旧使用原生WebSocket,APP与小程序使用uni-app的WebSocket协议,所以h5端任然可以支持长轮询等方式,APP与小程序只能支持WebSocket协议。
|
||||
|
||||
### 安装
|
||||
|
||||
```
|
||||
npm i @hyoga/uni-socket.io --save
|
||||
// yarn add @hyoga/uni-socket.io
|
||||
```
|
||||
|
||||
### 使用
|
||||
|
||||
与[socket.io-client](https://github.com/socketio/socket.io-client)完全相同,参考其写法即可。
|
||||
|
||||
### API
|
||||
|
||||
参考[官网API](https://socket.io/docs/client-api/)
|
||||
|
|
@ -1,5 +1,5 @@
|
|||
{
|
||||
"name": "@hyoga/uni-socket",
|
||||
"name": "@hyoga/uni-socket.io",
|
||||
"version": "1.0.0",
|
||||
"description": "适用于uni-app的socket.io封装,可用于uni-app、微信小程序",
|
||||
"keywords": [
|
||||
|
|
|
|||
Loading…
Reference in New Issue