Skip to content

Commit df3833e

Browse files
committed
add Usage tip
1 parent 68b7a47 commit df3833e

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,19 @@
11
# node-socket
22
TCP Socket with TLV packet (Node端基于TLV二进制协议格式进行封装的socket工具库,包括粘包断包处理)
3+
4+
5+
## Install
6+
7+
```
8+
$ npm install --save node-socket
9+
```
10+
11+
12+
## Usage
13+
14+
```js
15+
const socket = require('node-socket')
16+
socket.connect(port, host, onConnected, onReceived, onClosed)
17+
18+
//=> @see example.js
19+
```

0 commit comments

Comments
 (0)