chore: add badges to README#3
Merged
Merged
Conversation
Add CI status, npm version, TypeScript, license, Node.js, and Vercel AI SDK badges for at-a-glance project info. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
The content row was 1 character wider than the border rows, causing the right edge to render misaligned. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
ASCII box-drawing characters render with inconsistent widths across fonts, causing persistent misalignment. Mermaid renders as an SVG on GitHub so it displays correctly everywhere. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Mermaid renders \n literally in node labels; <br/> is the correct line break syntax. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Two divergent architecture diagrams are a maintenance risk. Keep the detailed version in docs/index.md as the single source of truth and link to it from the README. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
All three boxes had content rows 1 character wider than their border rows, causing the right edge to render misaligned. Co-Authored-By: Claude Opus 4.6 <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.
Summary
Test plan
🤖 Generated with Claude Code
Note
Low Risk
Documentation-only updates (badges/link tweaks and diagram formatting) with no runtime or API changes.
Overview
Adds a set of status/metadata badges (CI, npm, TypeScript, license, Node, Vercel AI SDK, Docs) to the top of
README.mdand includes a prominent link to the hosted documentation.Replaces the large ASCII architecture diagram in
README.mdwith a short textual pipeline description and a link to the docs’ architecture section, and lightly adjusts the diagram formatting indocs/index.mdfor alignment/consistency.Written by Cursor Bugbot for commit d0ba170. This will update automatically on new commits. Configure here.