Use Case

As a... user of the mongo-client-encryption package
I want... up to date docs on how to use the encryption module
So that... I can take advantage of the newest features

User Impact

• Anyone using the encryption package

Dependencies

• None

Unknowns

• None

Acceptance Criteria

Implementation Requirements

• Update the README to include cryptSharedLibPath wherever applicable
  • js doc comments, ts doc comments, cross-reference the driver types as well

Example:

const { MongoClient } = require("mongodb");
const { ClientEncryption } = require("mongodb-client-encryption");
  ...
const encOptions = {
   'keyVaultNamespace': `${keystoreDB}.${keystoreCollection}`,
   'kmsProviders': { 'local': localKey },
   'extraOptions': { 'cryptSharedLibPath': cryptSharedPath },
}

clientEncrypted = new MongoClient( uri, { 'autoEncryption': encOptions } );
await clientEncrypted.connect();

Testing Requirements

• N/A

Documentation Requirements

• N/A - this is a documentation task

Follow Up Requirements

• None