Skip to content

Commit 3aba9c8

Browse files
docs: update prebuild matrix in readme (#56)
1 parent 57b9640 commit 3aba9c8

File tree

1 file changed

+23
-15
lines changed

1 file changed

+23
-15
lines changed

README.md

+23-15
Original file line numberDiff line numberDiff line change
@@ -38,20 +38,6 @@ No verification is done when using npm to install the package. The contents of t
3838

3939
To verify the native `.node` packages, follow the same steps as above using `mongodb-js-zstd-X.Y.Z-platform.tgz` and the corresponding `.sig` file.
4040

41-
42-
## OS Support matrix
43-
44-
| | node12 | node14 | node16 | node18 | node20 |
45-
| ---------------- | ------ | ------ | ------ | ------ | ------ |
46-
| Windows x64 ||||||
47-
| macOS x64 ||||||
48-
| macOS arm64 ||||||
49-
| Linux x64 gnu ||||||
50-
| Linux arm gnu ||||||
51-
| Linux arm64 gnu ||||||
52-
| Linux x64 musl ||||||
53-
| Linux arm64 musl ||||||
54-
5541
## MongoDB Node.js Driver Version Compatibility
5642

5743
Only the following version combinations with the [MongoDB Node.js Driver](https://github.com/mongodb/node-mongodb-native) are considered stable.
@@ -64,6 +50,24 @@ Only the following version combinations with the [MongoDB Node.js Driver](https:
6450
| `[email protected]` || N/A |
6551
| `[email protected]` | N/A | N/A |
6652

53+
#### Prebuild Platforms
54+
55+
Below are the platforms that are available as prebuilds on each github release.
56+
`prebuild-install` downloads these automatically depending on the platform you are running npm install on.
57+
58+
- Linux GLIBC 2.23 or later
59+
- s390x
60+
- arm64
61+
- x64
62+
- Linux MUSL 1.1.20
63+
- arm64
64+
- x64
65+
- MacOS universal binary
66+
- x64
67+
- arm64
68+
- Windows
69+
- x64
70+
6771
## API
6872

6973
```ts
@@ -106,5 +110,9 @@ First, install and build the zstd library:
106110

107111
`npm run install-zstd`
108112

109-
Then:
113+
Then build the bindings:
114+
115+
`npm run prebuild`
116+
117+
Then test:
110118
`npm test`

0 commit comments

Comments
 (0)