From 383f31240466ed1d131bd08fd267215831129e9d Mon Sep 17 00:00:00 2001 From: philz3906 Date: Sat, 13 Jun 2026 11:19:11 +0800 Subject: [PATCH] docs: fix README version framing, npm badge, and Node requirement MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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) --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 31dc418..40d3cfc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Sentio API -[![npm version](https://badge.fury.io/js/@sentio%2Fapi.svg)](https://npmjs.com/package/@sentio/api) [![Release](https://github.com/sentioxyz/api/actions/workflows/cut-release.yaml/badge.svg)](https://github.com/sentioxyz/api/actions/workflows/cut-release.yaml) +[![npm version](https://img.shields.io/npm/v/@sentio/api.svg)](https://www.npmjs.com/package/@sentio/api) [![Release](https://github.com/sentioxyz/api/actions/workflows/cut-release.yaml/badge.svg)](https://github.com/sentioxyz/api/actions/workflows/cut-release.yaml) TypeScript client for the [Sentio](https://sentio.xyz) API. The bindings are generated from Sentio's protobuf definitions with @@ -10,10 +10,10 @@ through [connect-es](https://github.com/connectrpc/connect-es) with the transport — fully typed requests and responses, including server-streaming endpoints. -> **v3 is a breaking rewrite.** v2 (`openapi-ts` based: `client.setConfig` + +> **v2 is a breaking rewrite.** v1 (`openapi-ts` based: `client.setConfig` + > static service classes) is replaced by connect-es style clients. The REST > API itself is unchanged; see the examples below for the new shapes. The -> package is ESM-only and requires Node 20+. +> package is ESM-only and requires Node 24+. ## Setup