diff --git a/packages/secrets/README.md b/packages/secrets/README.md index 605c35206c..461c1f329f 100644 --- a/packages/secrets/README.md +++ b/packages/secrets/README.md @@ -45,3 +45,5 @@ const { keyring } = require("@zowe/secrets-for-zowe-sdk"); const wasDeleted = await keyring.deletePassword("ServiceName", "AccountName"); // wasDeleted should be true; ServiceName/AccountName removed from credential vault ``` + +For more detailed information, see [src/keyring/EXTENDERS.md](src/keyring/EXTENDERS.md). \ No newline at end of file diff --git a/packages/secrets/src/keyring/EXTENDERS.md b/packages/secrets/src/keyring/EXTENDERS.md index 0abea5fab7..3d3421eacb 100644 --- a/packages/secrets/src/keyring/EXTENDERS.md +++ b/packages/secrets/src/keyring/EXTENDERS.md @@ -2,11 +2,11 @@ ## What is `keyring`? -`keyring` is a cross-platform module meant to interact with OS (operating system) credential storage. `keyring` is written in Rust, and uses other Rust libraries to interface with credential storage APIs (application programming interfaces). It was designed to be a drop-in replacement for `node-keytar`, a Microsoft (formerly GitHub under "Atom") project that was archived on December 15th, 2022. For context, `node-keytar` has widespread use in multiple projects with over 500k weekly downloads - this library was created to avoid long-term conflicts/vulnerabilities that may arise with `node-keytar` now that it is no longer maintained. +`keyring` is a cross-platform module meant to interact with OS (operating system) credential storage. `keyring` is written in Rust, and uses other Rust libraries to interface with credential storage APIs (application programming interfaces). It was designed to be a drop-in replacement for `node-keytar`, a Microsoft (formerly GitHub under "Atom") project that was archived on December 15th, 2022. ## Why switch to `keyring`? -By continuing to use `node-keytar`, it opens up the user to future problems with the library itself or its dependencies. Until Microsoft provides an update to the status of `keytar` on NPM, it is unknown whether the package will continue to be supported. As a result, there was a demand for a replacement that can function identically to the original module. +As `node-keytar` is now unmaintained, there was a demand for a replacement that can function identically to the original module. As `keyring` was modeled after `node-keytar`, the same operations can be performed in credential storage: