From d459c8ff31ecf3baec7b880dd810f3a7431aba3d Mon Sep 17 00:00:00 2001 From: hasezoey Date: Tue, 2 Aug 2022 15:48:39 +0200 Subject: [PATCH] docs(compatibility): change to use a table --- docs/compatibility.md | 39 ++++++++++++++++++++++++++------------- 1 file changed, 26 insertions(+), 13 deletions(-) diff --git a/docs/compatibility.md b/docs/compatibility.md index 73b64c9e83a..f477f185d6b 100644 --- a/docs/compatibility.md +++ b/docs/compatibility.md @@ -1,20 +1,33 @@ # MongoDB Server Version Compatibility -Mongoose relies on the [MongoDB Node.js Driver](http://mongodb.github.io/node-mongodb-native/) to talk to MongoDB. + + +Mongoose relies on the [MongoDB Node.js Driver](http://mongodb.github.io/node-mongodb-native/) to talk to MongoDB. You can refer to [this table](https://docs.mongodb.com/drivers/node/current/compatibility/) for up-to-date information as to which version of the MongoDB driver supports which version of MongoDB. Below are the [semver](http://semver.org/) ranges representing which versions of mongoose are compatible with the listed versions of MongoDB server. -* MongoDB Server 2.4.x: mongoose `^3.8` or `4.x` -* MongoDB Server 2.6.x: mongoose `^3.8.8` or `4.x` -* MongoDB Server 3.0.x: mongoose `^3.8.22`, `4.x`, or `5.x` -* MongoDB Server 3.2.x: mongoose `^4.3.0` or `5.x` -* MongoDB Server 3.4.x: mongoose `^4.7.3` or `5.x` -* MongoDB Server 3.6.x: mongoose `5.x` -* MongoDB Server 4.0.x: mongoose `^5.2.0` or `6.x` -* MongoDB Server 4.2.x: mongoose `^5.7.0` or `6.x` -* MongoDB Server 4.4.x: mongoose `^5.10.0` or `6.x` -* MongoDB Server 5.x: mongoose `^6.0.0` -* MongoDB Server 6.x: mongoose `^6.5.0` +| MongoDB Sever | Mongoose | +| :-----------: | :----------------------------: | +| `6.x` | `^6.5.0` | +| `5.x` | `^6.0.0` | +| `4.4.x` | `^5.10.0 \| ^6.0.0` | +| `4.2.x` | `^5.7.0 \| ^6.0.0` | +| `4.0.x` | `^5.2.0 \| ^6.0.0` | +| `3.6.x` | `^5.0.0` | +| `3.4.x` | `^4.7.3 \| ^5.0.0` | +| `3.2.x` | `^4.3.0 \| 5.0.0` | +| `3.0.x` | `^3.8.22 \| ^4.0.0 \| ^5.0.0` | +| `2.6.x` | `^3.8.8 \| ^4.0.0` | +| `2.4.x` | `^3.8.0 \| ^4.0.0` | -Note that Mongoose 5.x dropped support for all versions of MongoDB before 3.0.0. If you need to use MongoDB 2.6 or older, use Mongoose 4.x. +Note that Mongoose `5.x` dropped support for all versions of MongoDB before `3.0.0`. If you need to use MongoDB `2.6` or older, use Mongoose `4.x`.