Skip to content

Polish README landing copy - #78

Merged
midagedev merged 1 commit into
mainfrom
docs/readme-landing-polish
Aug 30, 2026
Merged

Polish README landing copy#78
midagedev merged 1 commit into
mainfrom
docs/readme-landing-polish

Conversation

@midagedev

Copy link
Copy Markdown
Owner

Summary

  • Intro rewritten around the local Stripe API emulator framing: lead with "point your SDK's base URL at it — zero test branches", then the full-stack lab inventory, then the not-a-payment-processor boundary.
  • New Stripe API coverage badge (200/587 ops, links to the compatibility matrix). Must be bumped alongside the Compatibility Snapshot row on coverage waves.
  • Quick Start moved above Testing Model and now shows the one-line stripe-node config (host/port/protocol, the pattern the SDK smoke uses) right after the build commands.
  • Dropped the "distribution state" note from Quick Start (still stated in the Compatibility Snapshot and Known Limitations) and fixed a missing blank line before the Fixture APIs heading.

No technical content removed: reverse proxy, run isolation, per-run public base URL, fixtures, diagnostics sections are unchanged.

Verification

  • Docs-only change; rendered structure reviewed in the diff.
  • Badge URLs resolve against shields.io patterns used by the existing badges.

Gate status

No gate impact.

Lead with the emulator framing and the zero-branches promise, add a
Stripe API coverage badge, move Quick Start above the testing model,
and show the one-line Stripe SDK config that connects an app to the
local billing graph. All deployment and isolation sections keep their
full detail.
@midagedev
midagedev merged commit 424fe39 into main Aug 30, 2026
1 of 2 checks passed
@midagedev
midagedev deleted the docs/readme-landing-polish branch August 30, 2026 09:00
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