docs: Resuscitate the README - #385
Merged
Merged
Conversation
This update significantly improves the configuration and usage documentation for the Vault Ruby client. New sections cover SSL/TLS configuration options including passphrases, custom CA certificates, certificate stores, cipher specifications, and SNI hostname settings. Connection pool configuration is now documented with pool_size and pool_timeout options. A comprehensive KV Secrets Engine section distinguishes between v1 (unversioned) and v2 (versioned) APIs with clear examples for both. The documentation also adds a new Tokens section covering token lifecycle operations and a new API Coverage section that provides a quick reference for all available Vault clients and links to their respective API documentation. These additions provide users with better guidance on advanced SSL configuration, connection pooling, and secrets engine operations, reducing friction when configuring and using the client library.
schmichael
approved these changes
Feb 4, 2026
This was referenced Feb 4, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Time to bring the README forward into the year 2026
New sections cover SSL/TLS configuration options including passphrases, custom CA certificates, certificate stores, cipher specifications, and SNI hostname settings. Connection pool configuration is now documented with pool_size and pool_timeout options.
A comprehensive KV Secrets Engine section distinguishes between v1 (unversioned) and v2 (versioned) APIs with clear examples for both. The documentation also adds a new Tokens section covering token lifecycle operations and a new API Coverage section that provides a quick reference for all available Vault clients and links to their respective API documentation.
Closes #279
Closes #258