docs: fix README version framing, npm badge, and Node requirement#4
Merged
Conversation
The connect-es rewrite shipped as v2.0.0 (npm `latest`), replacing the 1.x openapi-ts client — the note incorrectly said "v3 replaces v2". - Correct the breaking-rewrite note to v2 over v1. - Swap the deprecated badge.fury.io npm badge for shields.io. - Node requirement is 24+ (matches package.json `engines`), not 20+. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What
Three doc-only corrections to
README.md, verified against the npm registry andpackage.json:openapi-tsbased)"openapi-tsbased)"badge.fury.io(deprecated/flaky)img.shields.io/npm/v/@sentio/apiWhy
latestis2.0.0— the connect-es / protobuf-es rewrite (deps@bufbuild/protobuf+@connectrpc/connect+@sentio/connect-gateway-es). The openapi-ts client it replaced was the1.xline (1.0.4depended on@hey-api/client-fetch). The README's "v3 replaces v2" framing was off-by-one and would mislead anyone who runsnpm install @sentio/apiand gets 2.0.0.badge.fury.iois effectively unmaintained; shields.io is the standard, reliably-cached source and links to the canonicalwww.npmjs.compackage page.package.jsonenginesrequiresnode >=24(andCLAUDE.mdsays Node 24+); the README said 20+.Notes for reviewer
README.mdis hand-written (not CI-ownedsrc/gen), so this is safe to edit here.createSentioClient/WebService/InsightsServiceand the@sentio/api/gen/...deep-import forProject) — all resolve; no example changes needed.docs:type does not trigger a semantic-release publish.🤖 Generated with Claude Code