Skip to content

Commit d70e863

Browse files
committed
chore: update docs
1 parent 64eb3a1 commit d70e863

File tree

5 files changed

+21
-21
lines changed

5 files changed

+21
-21
lines changed

.github/workflows/CI.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ jobs:
120120
- '12'
121121
- '14'
122122
- '16'
123+
- '18'
123124
runs-on: ubuntu-latest
124125
steps:
125126
- uses: actions/checkout@v3
@@ -157,6 +158,7 @@ jobs:
157158
- host: macos-latest
158159
target: x86_64-apple-darwin
159160
node:
161+
- '12'
160162
- '14'
161163
- '16'
162164
- '18'

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# node-unix-socket
22

3+
![npm_bandage](https://img.shields.io/npm/v/node-unix-socket) ![github_ci_status](https://github.com/bytedance/node-unix-socket/workflows/CI/badge.svg)
4+
35
`node-unix-socket` allows you to use some nonblocking unix sockets that are currently not supported by Node.js native modules, including:
46

57
- unix seqpacket(`SOCK_SEQPACKET`) sockets
@@ -8,6 +10,20 @@
810

911
`node-unix-socket` is a [napi-rs](https://napi.rs/) based [Node.js addons](https://nodejs.org/docs/latest-v16.x/api/addons.html). This lib uses [libuv](https://libuv.org/) inside Node.js so that it won't introduce any other asynchronous runtimes.
1012

13+
## Tested Platforms & Node.js
14+
15+
|Platform|Node.js|DgramSocket|Seqpacket|
16+
|---|---|---|---|
17+
|x64 Linux|12 + LTS|||
18+
|x64 Darwin|12 + LTS|||
19+
|aarch64 Darwin|12 + LTS|||
20+
21+
## Installation
22+
23+
```
24+
npm i node-unix-socket
25+
```
26+
1127
## API Documents
1228

1329
[API Documents](https://bytedance.github.io/node-unix-socket/)

npm/win32-x64-msvc/README.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

npm/win32-x64-msvc/package.json

Lines changed: 0 additions & 18 deletions
This file was deleted.

package.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@
2323
"napi": {
2424
"name": "node-unix-socket",
2525
"triples": {
26+
"default": false,
2627
"additional": [
28+
"x86_64-apple-darwin",
29+
"x86_64-unknown-linux-gnu",
2730
"aarch64-apple-darwin"
2831
]
2932
}

0 commit comments

Comments
 (0)