Skip to content

docs(NODE-6595): update compatibility table for [email protected] #53

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

Merged
merged 5 commits into from
Dec 5, 2024
Merged

docs(NODE-6595): update compatibility table for [email protected] #53

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1354ead
Update README.md
baileympearson Dec 5, 2024
93fd285
Update README.md
baileympearson Dec 5, 2024
bd15665
Update README.md
baileympearson Dec 5, 2024
c073968
Update README.md
baileympearson Dec 5, 2024
f071d80
Update README.md
baileympearson Dec 5, 2024
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
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# @mongodb-js/zstd

[![CI](https://github.com/mongodb-js/zstd/actions/workflows/CI.yml/badge.svg)](https://github.com/mongodb-js/zstd/actions/workflows/CI.yml)
[![CI](https://github.com/mongodb-js/zstd/actions/workflows/test.yml/badge.svg)](https://github.com/mongodb-js/zstd/actions/workflows/test.yml)

Zstandard compression library for Node.js

Expand Down Expand Up @@ -56,12 +56,15 @@ To verify the native `.node` packages, follow the same steps as above using `mon

Only the following version combinations with the [MongoDB Node.js Driver](https://github.com/mongodb/node-mongodb-native) are considered stable.

| | `@mongodb-js/[email protected]` |
| ------------- | ---------------------- |
| `[email protected]` | ✓ `^1.1.0` |
| `[email protected]` | ✓ |
| `[email protected]` | ✓ |
| `[email protected]` | N/A |
| | `@mongodb-js/[email protected]` | `@mongodb-js/[email protected]` |
| ---------------- | ---------------------- | ---------------------- |
| `mongodb@>=6.11` | ✓ `^1.1.0` | `^2.0.0` |
| `mongodb@<6.11` | ✓ `^1.1.0` | N/A |
| `[email protected]` | ✓ | N/A |
| `[email protected]` | ✓ | N/A |
| `[email protected]` | N/A | N/A |

`@mongodb-js/[email protected]` will work with `mongodb@<6.11` but will produce peer dependency errors upon installation.

## API

Expand Down
Loading