docs: narrow scope to protocol-only transport#3
Merged
Conversation
The previous README claimed full coverage of worlds, terrain, voting, economy, leaderboards, social, tournaments, and storage as stable features. The actual implementation is a thin WS+codec library with scaffolded typed REST helpers, and the architectural direction is to drop those helpers as the SDK narrows to a protocol-only transport. Rewrite the README to: - State the protocol-only scope explicitly - Mark typed REST helpers as deprecated for v1.0 - Show a working WebSocket-based quickstart using only the in-scope API - Point engine/framework integrations at examples/ rather than bundling No code change. Code refactor follows in a separate PR.
Taure
force-pushed
the
docs/scope-narrow-protocol-only
branch
from
621438c to
1e869dc
Compare
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
1 participant
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.
Summary
The previous README claimed full coverage of worlds, terrain, voting, economy, leaderboards, social, tournaments, and storage as stable features. The actual implementation is a thin WS+codec library with scaffolded typed REST helpers — and the architectural direction is to drop those helpers as the SDK narrows to a protocol-only transport, mirroring `asobi-lua-client`.
This PR is a credibility patch: rewrite the README to reflect the real and intended scope. No code change here; the code refactor (deleting the typed REST modules, dropping the unimplemented WS event types) follows in a separate PR.
Changes
Why
A README that overpromises is a credibility hole on Day 1 of any growth push. Honest scope reads as confident, not apologetic. Aligns with the architectural call that asobi-js is a protocol-only SDK; game-shape helpers belong in user code.
Test plan