docs(NODE-5524): add node driver compat info (#95)

mongodb-js · Aug 14, 2023 · c1284d1 · c1284d1
1 parent 634f064
commit c1284d1
Showing 1 changed file with 11 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -4,10 +4,19 @@ _A BSON parser Node.JS native addon._
 
 BSON is short for Binary JSON and is the binary-encoded serialization of JSON-like documents. You can learn more about it in [the specification](http://bsonspec.org).
 
-While this library is compatible with the mongodb driver version 4+, bson-ext will soon be deprecated and no longer supported.  It is strongly recommended
+While this library is compatible with the mongodb driver version 4+, bson-ext will soon be deprecated and no longer supported. It is strongly recommended
 that [js-bson](https://github.com/mongodb/js-bson) be used instead.
 
-**NOTE: bson-ext version 4+ works with js-bson version 4+ and the mongodb driver version 4+.**
+### 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.
+
+|               | `bson-ext@1.x` | `bson-ext@2.x` | `bson-ext@4.x` |
+| ------------- | -------------- | -------------- | -------------- |
+| `mongodb@6.x` | N/A            | N/A            | N/A            |
+| `mongodb@5.x` | N/A            | N/A            | N/A            |
+| `mongodb@4.x` | N/A            | N/A            | ✓              |
+| `mongodb@3.x` | ✓              | ✓              | N/A            |
 
 ## Installation