Skip to content

Commit c91c8c6

Browse files
authored
docs(NODE-5527): add nodejs driver compat table (#687)
* docs: add nodejs driver compat table * docs: nodejs readme whitespace fixes * docs: add the correct table for mongodb-client-encryption
1 parent 1edf123 commit c91c8c6

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,19 @@
1-
MongoDB Client Encryption
2-
=========================
1+
# MongoDB Client Encryption
32

43
The Node.js wrapper for [`libmongocrypt`](../../README.md)
54

6-
**Note** This library provides encryption functionality for the MongoDB Node.js driver but is **not intended** to be consumed in isolation. The public API that uses the functionality in this library is available in the `mongodb` package. We reserve the right to make breaking changes to `mongodb-client-encryption` that fall outside of semver.
5+
**Note** This library provides encryption functionality for the MongoDB Node.js driver but is **not intended** to be consumed in isolation. The public API that uses the functionality in this library is available in the `mongodb` package. We reserve the right to make breaking changes to `mongodb-client-encryption` that fall outside of semver.
6+
7+
### MongoDB Node.js Driver Version Compatibility
8+
9+
Only the following version combinations with the [MongoDB Node.js Driver](https://github.com/mongodb/node-mongodb-native) are considered stable.
10+
11+
12+
| ------------- | ------------------------------- | ------------------------------- | ------------------------------- |
13+
| `[email protected]` | N/A | N/A ||
14+
| `[email protected]` | N/A || N/A |
15+
| `[email protected]` ||| N/A |
16+
| `[email protected]` || N/A | N/A |
717

818
### Installation
919

@@ -14,6 +24,7 @@ npm install mongodb-client-encryption
1424
```
1525

1626
### Development
27+
1728
#### Setup
1829

1930
Run the following command to build libmongocrypt and setup the node bindings for development:
@@ -26,10 +37,10 @@ bash ./etc/build-static.sh
2637

2738
We lint both the c++ bindings and the Typescript.
2839

29-
To lint the Typescript, you can run `npm run check:eslint -- --fix`. To lint the c++, run `npm run clang-format`.
40+
To lint the Typescript, you can run `npm run check:eslint -- --fix`. To lint the c++, run `npm run clang-format`.
3041

3142
#### Testing
3243

33-
The unit tests require the binding to be built. Run `npm run rebuild` to build the addon from the c++ source. Then the tests can be run with `npm test`.
44+
The unit tests require the binding to be built. Run `npm run rebuild` to build the addon from the c++ source. Then the tests can be run with `npm test`.
3445

35-
Note: changes to c++ source are not automatically re-compiled. One needs to rebuild the bindings after each change.
46+
Note: changes to c++ source are not automatically re-compiled. One needs to rebuild the bindings after each change.

0 commit comments

Comments
 (0)