Repository navigation
Make the README a short, uniform guide for newcomers - #27
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 README opened with the wire contract, without saying who needs this module. It now uses the same seven sections as the other Weir repositories, tells applications to use the SDK instead, defines the main terms and includes a small runnable program.
The semantics and the generation and release steps moved unchanged to
docs/, with headings added. The install line now names theapi/protocolpackage, because the module path alone leavesgo runwith missinggo.sumentries.I ran the quick start as written on macOS arm64. It installs v0.17.1 because v0.17.0 predates the Go and
x/netupdates that release made. Remaining gap: the code generation steps moved without being rerun, since no schema changed.