Skip to content

Make the README a short, uniform guide for newcomers - #36

Merged
liran merged 3 commits into
mainfrom
docs/readme-template
Nov 4, 2026
Merged

liran merged 3 commits into
mainfrom
docs/readme-template

Conversation

@liran

@liran liran commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

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.

@liran liran self-assigned this Nov 4, 2026
@liran
liran merged commit 12342c2 into main Nov 4, 2026
3 checks passed
@liran
liran deleted the docs/readme-template branch November 4, 2026 13:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant