docs: fix low-level request example and align readme with other SDKs - #124
Merged
Merged
Conversation
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
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.
The low-level HTTP example targeted
https://example.com, which the client rejects at runtime because requests must go to the attested enclave; it now usestfclient.enclave. Therelease_tagcomment claimed it isNonefor bundled verification, but bundles do populate it.Also reorders the README to match the other Tinfoil SDKs and links the prompt cache section to the shared docs page instead of repeating it.
Summary by cubic
Restructures the README to match the other Tinfoil SDKs and fixes two incorrect examples.
tfclient.enclaveinstead ofhttps://example.com, which the client rejects at runtime.release_tagcomment, which incorrectly claimed it isNonefor bundled verification.Written for commit db0d85b. Summary will update on new commits.