Repository navigation
Make the README a short, uniform guide for newcomers - #36
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 held the SDK's whole contract, which made it hard to find how to start. It now uses the same seven sections as the other Weir repositories, with the methods, backend formats, mutation outcomes and basic rules up front, and a complete program that writes and reads one record.
The contract itself moved unchanged to
docs/, with headings added. The quick start links to the Weir server's quick start, which arrives with the matching change in batchstream/weir.I ran the quick start as written against a local server on macOS arm64 and installed v0.23.1, which adds only the license and docs to v0.23.0. Remaining gap: it covers MongoDB only. Merge batchstream/weir#155 first so the link to its quick start resolves.