Add usage guide, recipes and a comparison with other Node Vault clients
Four pages replacing the default stub:
Home - what the client is and the 30-second integration.
Getting Started - requirements, boot/get/clear, every option, all four
auth backends, first read/write, shutdown.
Recipes - thirteen worked use cases: config at boot, node-config,
Kubernetes, AWS IAM, KV v2, namespaces, rotation, merge-patch, version
management, the raw escape hatch, typed errors, testing without a Vault,
graceful shutdown.
Why this client - how it compares to node-vault, @litehex/node-vault,
hashi-vault-js and vault-api on KV handling, token lifecycle, config
integration and release hygiene.
Every snippet was executed against a stubbed Vault before being written
down, which caught two things the README would have led me to publish:
request() silently ignores a fourth headers argument, and readMetadata()
resolves to the response envelope, so the metadata is under .data.
The comparison was compiled by reading each project's published source,
package metadata and CI config; it is dated and states its scope, since
these facts drift.
kurok
committed
Aug 31, 2026