Adds short tutorial to readme and simple example, improves package docs #98
Conversation
This file contains 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
* Adds simple example * Adds relevant package docs
EthanHeilman
force-pushed
the
readmehowto
branch
from
49f3916
to
2cb5500
Compare
whalelines
reviewed
Feb 7, 2024
README.md
Outdated
| Next we create the OpenPubkey client and call `opkClient.Auth`: | ||
| ```golang | ||
| opkClient, err := client.New(op) | ||
| pkt, err := opkClient.Auth(context.TODO()) |
There was a problem hiding this comment.
Should some comment be made about context.TODO()?
There was a problem hiding this comment.
What do you suggest?
There was a problem hiding this comment.
What is it and why is it called TODO? What is to be done?
There was a problem hiding this comment.
Changed this to use context.Background() instead. I want to get developers up and running with requiring that make as few choices as possible. context.TODO() implies that should replace the context with something else. Instead I'd rather give them a sane default.
EthanHeilman
force-pushed
the
readmehowto
branch
from
dd97be0
to
64cd20e
Compare
EthanHeilman
requested review from
whalelines and
jonnystoten
and removed request for
whalelines
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.
This PR is written to address and close #78 by adding a short "Getting Started" tutorial to the readme.
To support this tutorial this PR also adds a very simple signing and verifying example and improves package docs on functions used in the tutorial.
This PR also cleans up most of the markdown warnings in the README and adds
typclaim to the commitmentThis simple example will likely slowly replace the google example. Future work is to merge the Google example with the X509 example to create a general purpose signing utility. The creation this signing utility will be done in a future PR and will not be done in this PR.