docs: add Ruby API documentation to README#306
Open
andrewdunndev wants to merge 1 commit into
Open
Conversation
Add library usage examples covering verification with the public Sigstore instance, custom trust roots for self-hosted infrastructure, offline verification, and the Policy system. Add installation instructions and a factory method reference table. Closes sigstore#303 Signed-off-by: Andrew Dunn <andrew@dunn.dev>
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
1 participant
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.
Closes #303.
Add library usage examples to the README covering:
All examples are derived from the library source (
lib/sigstore/verifier.rb,lib/sigstore/trusted_root.rb,lib/sigstore/policy.rb). The custom trust root and offline verification sections address self-hosted use cases that are supported by the library but not currently documented.