Skip to content

Commit 1edf123

Browse files
docs(NODE-5425): update Node bindings docs (#685)
* docs(NODE-5425 ): update Node bindings docs * Update README.md * Update bindings/node/README.md Co-authored-by: Durran Jordan <[email protected]> --------- Co-authored-by: Durran Jordan <[email protected]>
1 parent c7dd6a5 commit 1edf123

File tree

1 file changed

+4
-14
lines changed

1 file changed

+4
-14
lines changed

README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ MongoDB Client Encryption
33

44
The Node.js wrapper for [`libmongocrypt`](../../README.md)
55

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.
7+
68
### Installation
79

810
You can install `mongodb-client-encryption` with the following:
@@ -28,18 +30,6 @@ To lint the Typescript, you can run `npm run check:eslint -- --fix`. To lint th
2830

2931
#### Testing
3032

31-
Some tests require a standalone server to be running with authentication enabled. Set up a single
32-
server running with the following conditions:
33-
34-
| param | value |
35-
|-----------|-----------|
36-
| host | localhost |
37-
| port | 27017 |
38-
39-
This is the standard setup for a standalone server with no authentication.
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`.
4034

41-
Run the test suite using:
42-
43-
```bash
44-
npm test
45-
```
35+
Note: changes to c++ source are not automatically re-compiled. One needs to rebuild the bindings after each change.

0 commit comments

Comments
 (0)