Skip to content

Commit eb3d5f5

Browse files
authored
Revise README for SolidStart example
Signed-off-by: Thomas <thomas.giudici@proton.me>
1 parent 5c9b122 commit eb3d5f5

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

examples/with-solidstart/README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
[![Banner](https://assets.solidjs.com/banner?background=tiles&type=Start&project=template)](https://github.com/solidjs/solid-start)
1+
[![Banner](https://github.com/blocknative/web3-onboard/blob/develop/assets/core.svg)](https://web3onboard.thirdweb.com)
22

3-
Launch your DeFi app with this starter template, featuring [SolidStart](https://start.solidjs.com) with server-side rendering capabilities and [Web3Onboard](https://web3onboard.thirdweb.com) for seamless Web3 integration with [ethers.js](https://github.com/ethers-io/ethers.js).
3+
# SolidStart Example
4+
5+
Everything you need to integrate Web3Onboard in [SolidStart](https://start.solidjs.com)
46

57
## Features
68

7-
- **SSR Compliant**: Web3 code loads only on the client, ensuring compatibility with SSR architecture
9+
- **SSR Compliant**: Web3 code loads only on the client
810
- **Auth Context**: A reactive context to monitor wallet changes, handle signatures, and more
911
- **Database**: Includes `unstorage`, a lightweight file-based DB
1012
- **Client-Only**: Easily isolate client-side logic for Web3 interactions
@@ -35,18 +37,18 @@ For more details, refer to SolidStart's [README.md](https://github.com/solidjs/s
3537

3638
## Usage
3739

38-
To ensure Web3-related logic runs only on the client, use the `clientOnly` utility from SolidStart. Here are two ways to implement client-only code:
40+
To ensure Web3-related logic runs only on the client, use the `clientOnly` utility from SolidStart.
41+
Here are two ways to implement client-only code:
3942

40-
1. **Client-Only Component** (e.g. for a component showing user balance)
43+
1. **In Component** (e.g. for a component showing eth balance)
4144

4245
```jsx
4346
import { clientOnly } from "@solidjs/start/client";
4447

4548
const ClientComponent = clientOnly(() => import("./ClientOnlyComponent"));
4649
```
4750

48-
2. **Client-Only Page** (e.g. for a `/swap` page)
49-
Add the following at the top of your route file to render the entire page on the client:
51+
2. **In Routes** (e.g. for a `/swap` page)
5052

5153
```jsx
5254
import { clientOnly } from "@solidjs/start/client";

0 commit comments

Comments
 (0)