You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-6Lines changed: 17 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,19 @@
1
-
MongoDB Client Encryption
2
-
=========================
1
+
# MongoDB Client Encryption
3
2
4
3
The Node.js wrapper for [`libmongocrypt`](../../README.md)
5
4
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.
Run the following command to build libmongocrypt and setup the node bindings for development:
@@ -26,10 +37,10 @@ bash ./etc/build-static.sh
26
37
27
38
We lint both the c++ bindings and the Typescript.
28
39
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`.
30
41
31
42
#### Testing
32
43
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`.
34
45
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