docs

Author: baileympearson

README.md

@@ -121,6 +121,11 @@ NOTE: The test suite requires an active kerberos deployment.
 <dd></dd>
 <dt><a href="#KerberosServer">KerberosServer</a></dt>
 <dd></dd>
+<dt><del><a href="#MongoAuthProcess">MongoAuthProcess</a></del></dt>
+<dd><p>A class that was used for MongoDB kerberos authentication with legacy
+MongoDB Node drivers (<code>mongodb&lt;4.0</code>).</p>
+<p>Not intended for direct use.</p>
+</dd>
 </dl>
 
 ## Functions
@@ -238,6 +243,16 @@ Perform the client side kerberos unwrap step
 Processes a single kerberos server-side step using the supplied client data.
 
 **Returns**: <code>Promise</code> - returns Promise if no callback passed  
+<a name="MongoAuthProcess"></a>
+
+## ~~MongoAuthProcess~~
+***This class will be removed in an upcoming major release.***
+
+A class that was used for MongoDB kerberos authentication with legacy
+MongoDB Node drivers (`mongodb<4.0`).
+
+Not intended for direct use.
+
 <a name="checkPassword"></a>
 
 ## checkPassword(username, password, service, [defaultRealm], [callback])

package.json

@@ -59,7 +59,7 @@
     "format-js": "ESLINT_USE_FLAT_CONFIG=false eslint lib test --fix",
     "check:lint": "ESLINT_USE_FLAT_CONFIG=false eslint lib test",
     "precommit": "check-clang-format",
-    "docs": "jsdoc2md --template etc/README.hbs --plugin dmd-clear --files lib/kerberos.js > README.md",
+    "docs": "jsdoc2md --template etc/README.hbs --plugin dmd-clear --files lib/kerberos.js lib/auth_processes/mongodb.js > README.md",
     "test": "mocha 'test/*_tests.js'",
     "prebuild": "prebuild --runtime napi --strip --verbose --all"
   },