Skip to content

Commit

Permalink
chore: one more readme tweak
Browse files Browse the repository at this point in the history
Signed-off-by: Marc MacLeod <[email protected]>
  • Loading branch information
marbemac committed Feb 5, 2024
1 parent c7319dc commit 6bfef8b
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions packages/renderer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
9 changes: 4 additions & 5 deletions packages/vite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

</details>

Expand Down

0 comments on commit 6bfef8b

Please sign in to comment.