[dinwwwh]

Requested by dinwwwh · project thread

Summary

The root README and the 29 package READMEs (the pages people see on npm) go straight from the badges to the package table, so nothing on them says what oRPC is. Search engines and AI assistants read these pages heavily, and they had no plain definition to quote.

This adds the same short block to every README, right after the badges:

• A two-sentence definition that starts with "oRPC is a TypeScript framework for building end-to-end typesafe APIs", using the same wording as the orpc.dev hero and meta description (typed client, OpenAPI REST API, MCP tools, no code generation, runs on Node.js, Bun, Deno, and Cloudflare Workers).
• A minimal router and client example, the same planet.find example used on the home page and in Getting Started, written with the v2 API (origin + url on RPCLink).
• The documentation link now says "orpc.dev" and links to the Getting Started guide, instead of "[here]".

The package READMEs are still identical to the root README below the badges, so they stay easy to keep in sync.

Verification

• Pulled both code blocks out of the README and ran tsc against the workspace packages. They compile, and planet resolves to { id: number, name: string } (assigning it to string fails as expected, so it is not any).
• pnpm lint passes (ESLint also lints the code blocks in Markdown).

---

Generated by Claude Code

[macroscopeapp]

Approvability

Verdict: Approved at 9f8ceae

Macroscope's review found this PR approvable — This PR only adds descriptive README text, fenced usage examples, and clearer documentation links across the repository and package READMEs. It does not modify executable code or production behavior.

^{You can add or adjust custom eligibility rules. Learn more.}

[cloudflare-workers-and-pages]

Deploying with    Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status	Name	Latest Commit	Preview URL	Updated (UTC)
✅ Deployment successful! View logs	orpc	9f8ceae	Commit Preview URL Branch Preview URL	Oct 23 2026, 02:51 AM

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[pullfrog]

✅ No new issues found.

Reviewed changes — docs-only change adding an identical definition + quick example block to the root and 29 package READMEs.

• Definition added — a two-sentence plain-English definition of oRPC placed after the badges, consistent with the index.astro meta description and Hero.astro wording.
• Quick example added — a server router (os.input(...).handler(...)) and client (RPCLink({ origin, url }) + createORPCClient + RouterClient<typeof router>) snippet.
• Documentation line rewritten — replaced the [here] link with an explicit orpc.dev link and a Getting Started guide link.

All 30 added blocks are byte-identical, the example matches apps/content/docs/getting-started.mdx (the origin + url options on RPCLink are the current v2 API), planet.find correctly types as { id: number, name: string }, and both new links resolve (/docs/rpc/handler and /docs/getting-started both exist). The fan-out across every README follows the existing duplicated-badge convention and is not touched by the Sponsors sync.

  ^{｜ View workflow run ｜ Using deepseek-v4.1-flash (free via Pullfrog for OSS) ｜ 𝕏}

[pkg-pr-new]

More templates

• @orpc/bun-playground
• @orpc/cloudflare-playground
• @orpc/nest-playground
• @orpc/next-playground

@orpc/ai-sdk

npm i https://pkg.pr.new/@orpc/ai-sdk@2312

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@2312

@orpc/bun

npm i https://pkg.pr.new/@orpc/bun@2312

@orpc/client

npm i https://pkg.pr.new/@orpc/client@2312

@orpc/cloudflare

npm i https://pkg.pr.new/@orpc/cloudflare@2312

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@2312

@orpc/experimental-effect

npm i https://pkg.pr.new/@orpc/experimental-effect@2312

@orpc/evlog

npm i https://pkg.pr.new/@orpc/evlog@2312

@orpc/hibernation

npm i https://pkg.pr.new/@orpc/hibernation@2312

@orpc/json-schema

npm i https://pkg.pr.new/@orpc/json-schema@2312

@orpc/experimental-lock

npm i https://pkg.pr.new/@orpc/experimental-lock@2312

@orpc/mcp

npm i https://pkg.pr.new/@orpc/mcp@2312

@orpc/msw

npm i https://pkg.pr.new/@orpc/msw@2312

@orpc/nest

npm i https://pkg.pr.new/@orpc/nest@2312

@orpc/next

npm i https://pkg.pr.new/@orpc/next@2312

@orpc/node

npm i https://pkg.pr.new/@orpc/node@2312

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@2312

@orpc/opentelemetry

npm i https://pkg.pr.new/@orpc/opentelemetry@2312

@orpc/pinia-colada

npm i https://pkg.pr.new/@orpc/pinia-colada@2312

@orpc/pino

npm i https://pkg.pr.new/@orpc/pino@2312

@orpc/publisher

npm i https://pkg.pr.new/@orpc/publisher@2312

@orpc/ratelimit

npm i https://pkg.pr.new/@orpc/ratelimit@2312

@orpc/server

npm i https://pkg.pr.new/@orpc/server@2312

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@2312

@orpc/swr

npm i https://pkg.pr.new/@orpc/swr@2312

@orpc/tanstack-query

npm i https://pkg.pr.new/@orpc/tanstack-query@2312

@orpc/trpc

npm i https://pkg.pr.new/@orpc/trpc@2312

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@2312

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@2312

commit: 9f8ceae

[codspeed]

Merging this PR will not alter performance

1 warning

⚠️ 5 benchmarks are dominated by system calls

System calls cannot be simulated consistently and are left out of the measure. The reported value understates the real cost. Switch to the Walltime instrument to measure them.

Learn more about system calls

See affected benchmarks

✅ 28 untouched benchmarks
⏩ 2 skipped benchmarks¹

---

_{Comparing claude/project-thread-hdk3xe (9f8ceae) with main (07c2593)}

Footnotes

1. 2 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩