Skip to content

docs: fix README version framing, npm badge, and Node requirement #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
philz3906 merged 1 commit into from
Jun 13, 2026
Merged

docs: fix README version framing, npm badge, and Node requirement #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand Down
Loading