Skip to content

docs(chat): note the pre-1.0 API contract in the README - #55

Merged
rpvilo merged 1 commit into
mainfrom
feature/readme-prerelease-note
Aug 3, 2026
Merged

docs(chat): note the pre-1.0 API contract in the README#55
rpvilo merged 1 commit into
mainfrom
feature/readme-prerelease-note

Conversation

@rpvilo

@rpvilo rpvilo commented Aug 3, 2026

Copy link
Copy Markdown
Collaborator

Adds a short Status section near the top of the package README, so anyone landing on the npm page knows the API is still settling before they build on it.

## Status

Pre-1.0. The primitives are in real use, but the API is still settling and
minor releases may contain breaking changes — the usual `0.x` semver contract.
Pin an exact version if that matters to you, and check the changelog when upgrading.

The 0.x version number already implies this by convention, but conventions are easy to miss and the alternative — hiding the release behind a beta dist-tag — costs discoverability for no real benefit while there are no consumers to protect.

No changeset, deliberately

files ships README.md, so this reaches npm with 0.1.0 as long as it merges before #52. Adding a changeset would give #52 a second changelog entry, which is exactly the noise #54 just removed — and the README text is part of the initial release, not a change to it.

If #52 merges first, this needs a patch changeset instead and ships as 0.1.1.

Scope

One file. Lint clean; no code, no changesets touched.

@vercel

vercel Bot commented Aug 3, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
intentface-chat Ready Ready Preview Aug 3, 2026 6:44pm

Request Review

@rpvilo
rpvilo merged commit 4a64252 into main Aug 3, 2026
3 checks passed
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