Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(NODE-5523): add component support matrix to readme #3806

Merged
merged 11 commits into from
Aug 15, 2023
Merged

docs(NODE-5523): add component support matrix to readme #3806

Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
7a4410f
docs: add component support matrix to readme
dariakp Aug 10, 2023
ef794da
fix: escape special character
dariakp Aug 10, 2023
b420382
docs: add links to add-on libs
dariakp Aug 10, 2023
add47b5
fix: more escape characters
dariakp Aug 10, 2023
dae6f56
fix: formatting
dariakp Aug 10, 2023
6f64092
Merge branch 'main' into NODE-5523/readme-component-support
durran Aug 10, 2023
2a64dce
Update README.md
dariakp Aug 11, 2023
8e52b26
docs: adjust compat table for bson and bson-ext
dariakp Aug 11, 2023
7d44569
Update README.md
dariakp Aug 11, 2023
70d24b5
Merge branch 'main' into NODE-5523/readme-component-support
durran Aug 14, 2023
e4d6bb7
Merge branch 'main' into NODE-5523/readme-component-support
durran Aug 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 26 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@ The official [MongoDB](https://www.mongodb.com/) driver for Node.js.

## Quick Links

| Site | Link |
| -------------------------| ----------------------------------------------------------------------------------------------------------------- |
| Documentation | [www.mongodb.com/docs/drivers/node](https://www.mongodb.com/docs/drivers/node) |
| API Docs | [mongodb.github.io/node-mongodb-native](https://mongodb.github.io/node-mongodb-native) |
| `npm` package | [www.npmjs.com/package/mongodb](https://www.npmjs.com/package/mongodb) |
| MongoDB | [www.mongodb.com](https://www.mongodb.com) |
| MongoDB University | [learn.mongodb.com](https://learn.mongodb.com/catalog?labels=%5B%22Language%22%5D&values=%5B%22Node.js%22%5D) |
| MongoDB Developer Center | [www.mongodb.com/developer](https://www.mongodb.com/developer/languages/javascript/) |
| Site | Link |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------- |
| Documentation | [www.mongodb.com/docs/drivers/node](https://www.mongodb.com/docs/drivers/node) |
| API Docs | [mongodb.github.io/node-mongodb-native](https://mongodb.github.io/node-mongodb-native) |
| `npm` package | [www.npmjs.com/package/mongodb](https://www.npmjs.com/package/mongodb) |
| MongoDB | [www.mongodb.com](https://www.mongodb.com) |
| MongoDB University | [learn.mongodb.com](https://learn.mongodb.com/catalog?labels=%5B%22Language%22%5D&values=%5B%22Node.js%22%5D) |
| MongoDB Developer Center | [www.mongodb.com/developer](https://www.mongodb.com/developer/languages/javascript/) |
| Stack Overflow | [stackoverflow.com](https://stackoverflow.com/search?q=%28%5Btypescript%5D+or+%5Bjavascript%5D+or+%5Bnode.js%5D%29+and+%5Bmongodb%5D) |
| Source Code | [github.com/mongodb/node-mongodb-native](https://github.com/mongodb/node-mongodb-native) |
| Upgrade to v5 | [etc/notes/CHANGES_5.0.0.md](https://github.com/mongodb/node-mongodb-native/blob/HEAD/etc/notes/CHANGES_5.0.0.md) |
| Contributing | [CONTRIBUTING.md](https://github.com/mongodb/node-mongodb-native/blob/HEAD/CONTRIBUTING.md) |
| Changelog | [HISTORY.md](https://github.com/mongodb/node-mongodb-native/blob/HEAD/HISTORY.md) |
| Source Code | [github.com/mongodb/node-mongodb-native](https://github.com/mongodb/node-mongodb-native) |
| Upgrade to v5 | [etc/notes/CHANGES_5.0.0.md](https://github.com/mongodb/node-mongodb-native/blob/HEAD/etc/notes/CHANGES_5.0.0.md) |
| Contributing | [CONTRIBUTING.md](https://github.com/mongodb/node-mongodb-native/blob/HEAD/CONTRIBUTING.md) |
| Changelog | [HISTORY.md](https://github.com/mongodb/node-mongodb-native/blob/HEAD/HISTORY.md) |

### Bugs / Feature Requests

Expand All @@ -42,11 +42,24 @@ Change history can be found in [`HISTORY.md`](https://github.com/mongodb/node-mo

### Compatibility

For version compatibility matrices, please refer to the following links:
For server and runtime version compatibility matrices, please refer to the following links:

- [MongoDB](https://www.mongodb.com/docs/drivers/node/current/compatibility/#mongodb-compatibility)
- [NodeJS](https://www.mongodb.com/docs/drivers/node/current/compatibility/#language-compatibility)

#### Component Support Matrix

The following table describes add-on compponent version compatibility for the Node.js driver. Only packages with versions in these supported ranges are stable when used in combination.

| Component | mongodb@3.x | mongodb@4.x | mongodb@5.x | mongodb@6.x |
| ------------------------- | ----------- | ------------------ | ------------------ | ----------- |
| bson | ^1.0.0 | ^2.0.0 | ^5.0.0 | ^6.0.0 |
| bson-ext | ^1.0.0 | ^2.0.0 | N/A | N/A |
| kerberos | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.0.0 |
| mongodb-client-encryption | ^1.0.0 | ^1.0.0 \|\| ^2.0.0 | ^2.3.0 | ^6.0.0 |
| mongodb-legacy | N/A | ^4.0.0 | ^5.0.0 | ^6.0.0 |
| \@mongodb-js/zstd | N/A | ^1.0.0 | ^1.0.0 | ^1.1.0 |

#### Typescript Version

We recommend using the latest version of typescript, however we currently ensure the driver's public types compile against `typescript@4.1.6`.
Expand Down