From 6af7e6b6033e7c2a85943ff887b25495331a5c16 Mon Sep 17 00:00:00 2001 From: Daria Pardue Date: Fri, 11 Aug 2023 16:39:35 -0400 Subject: [PATCH 1/2] docs: add driver version compat table --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6d92241..040c3cd 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Zstandard compression library for Node.js npm install @mongodb-js/zstd ``` -## Support matrix +## OS Support matrix | | node12 | node14 | node16 | node18 | node20 | | ---------------- | ------ | ------ | ------ | ------ | ------ | @@ -23,6 +23,17 @@ npm install @mongodb-js/zstd | Linux x64 musl | ✓ | ✓ | ✓ | ✓ | ✓ | | Linux arm64 musl | ✓ | ✓ | ✓ | ✓ | ✓ | +## MongoDB Node.js Driver Version Compatibility + +Only the following version combinations with the [MongoDB Node.js Driver](https://github.com/mongodb/node-mongodb-native) are considered stable. + +| | `@mongodb-js/zstd@1.x` | +| ------------- | ---------------------- | +| `mongodb@6.x` | ✓ _(^1.1.0)_ | +| `mongodb@5.x` | ✓ | +| `mongodb@4.x` | ✓ | +| `mongodb@3.x` | N/A | + ## API ```ts From ef33c472dc124357d1f1e149d7beba5530f16d25 Mon Sep 17 00:00:00 2001 From: Daria Pardue Date: Fri, 11 Aug 2023 16:45:20 -0400 Subject: [PATCH 2/2] docs: format version annotation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 040c3cd..e8823a9 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ Only the following version combinations with the [MongoDB Node.js Driver](https: | | `@mongodb-js/zstd@1.x` | | ------------- | ---------------------- | -| `mongodb@6.x` | ✓ _(^1.1.0)_ | +| `mongodb@6.x` | ✓ `^1.1.0` | | `mongodb@5.x` | ✓ | | `mongodb@4.x` | ✓ | | `mongodb@3.x` | N/A |