Skip to content

Give the README a header in the family of verified-cli's - #6

Merged
zy4 merged 1 commit into
mainfrom
readme-header
Oct 11, 2026
Merged

zy4 merged 1 commit into
mainfrom
readme-header

Conversation

@zy4

@zy4 zy4 commented Oct 11, 2026

Copy link
Copy Markdown
Contributor

Brings the README's top in line with verified-cli's, recognisably the same project and visibly the TypeScript one. The Python SDK gets the matching change in dekrops/verified-python#16.

  • Wordmark (docs/assets/wordmark-{light,dark}.svg): the CLI's mark, three linked records with the last one open, and the same monospace verified. The shell's $ becomes Node's >, and a small ts tag sits beside the name in TypeScript's blue.
  • Tagline and badges in the CLI's layout: CI, npm version, licence, Node version, protocol status.
  • A first example where the CLI shows a console session: a verification that completes, a decision of CONTRADICTED, and requireSupported() refusing it. The README test runs it and checks its output and its error.
  • Status as a callout, as in the CLI's README.

Nothing below "Install" changes.

Preview it on the branch: https://github.com/dekrops/verified-typescript/tree/readme-header

Two things to know:

  • The images use absolute URLs to main, so that they also render on npm. They will show as broken in this PR's preview until it is merged.
  • npm shows the old README until the next release.

🤖 Generated with Claude Code

The wordmark is verified-cli's mark, a run of linked records with the last
one open, set at Node's prompt instead of a shell's and tagged with the
language. Below it: a tagline, badges, a first example in place of the
CLI's console session, and the status as a callout. The example runs in
the README test like the others.

Images are referenced by absolute URL so that they also render on npm.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@zy4
zy4 merged commit cbe943c into main Oct 11, 2026
10 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.

2 participants