diff --git a/README.md b/README.md index 01230ea..1f4aaa1 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,11 @@ framework agnostic on the client and the server - use React, Solid, Hono, H3, Cl SSRx is split into two parts that can be used independently, or together. -**[`@ssrx/vite`](/packages/vite/README.md)** +**[`@ssrx/vite`](/packages/vite)** A Vite plugin to improve the DX of developing SSR apps. -**[`@ssrx/renderer`](/packages/renderer/README.md)** +**[`@ssrx/renderer`](/packages/renderer)** Establishes some patterns to hook into the lifecycle of streaming SSR apps in a framework/library agnostic way. A handful of renderer plugins for common libraries are maintained in this repo. diff --git a/packages/renderer/README.md b/packages/renderer/README.md index 4e31fbd..5efde13 100644 --- a/packages/renderer/README.md +++ b/packages/renderer/README.md @@ -5,8 +5,8 @@ agnostic way. It is client and server framework agnostic, so long as the server AsyncLocalStorage (node 18+, bun, deno, cloudflare, vercel, etc). A handful of renderer plugins for common libraries are maintained in this repo. -See the [react-router-kitchen-sink](/examples/react-router-kitchen-sink/README.md) and -[remix-vite](/examples/remix-vite/README.md) examples for a look at how everything can work together in practice. +See the [react-router-kitchen-sink](/examples/react-router-kitchen-sink) and [remix-vite](/examples/remix-vite) examples +for a look at how everything can work together in practice. ## Usage diff --git a/packages/vite/README.md b/packages/vite/README.md index 9803ba3..9cfd866 100644 --- a/packages/vite/README.md +++ b/packages/vite/README.md @@ -27,10 +27,9 @@ A Vite plugin that improves the DX of developing SSR apps. ## Examples The SSRx Vite plugin is barebones and (mostly) unopinionated by design, and can be used standalone. See the -[`bun-react-router`](/examples/bun-react-router/README.md), -[`react-router-simple`](/examples/react-router-simple/README.md), -[`tanstack-router-simple`](/examples/tanstack-router-simple/README.md), and -[`solid-router-simple`](/examples/solid-router-simple/README.md) examples. +[`bun-react-router`](/examples/bun-react-router), [`react-router-simple`](/examples/react-router-simple), +[`tanstack-router-simple`](/examples/tanstack-router-simple), and [`solid-router-simple`](/examples/solid-router-simple) +examples. ## Usage @@ -118,7 +117,7 @@ type Route = { ``` `react-router` and `solid-router` both conform to this shape out of the box. You can provide your own `routerAdapter` if -your routes config does not - see [plugin-tanstack-router](/packages/plugin-tanstack-router/README.md) for an example. +your routes config does not - see [plugin-tanstack-router](/packages/plugin-tanstack-router) for an example.