add example readme

cah4a · Jul 1, 2024 · 613a70b · 613a70b
1 parent 6773326
commit 613a70b
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/example/README.md b/example/README.md
@@ -1,15 +1,24 @@
 # trpc-bun-adapter-example
 
-To install dependencies:
+This is a minimal example of how to use the `trpc-bun-adapter` package.
+
+## Run example
+
+Install dependencies:
 
 ```bash
 bun install
 ```
 
-To run:
+Bundle client code:
+
+```bash
+bun bundle
+```
+
+Start the server
 
 ```bash
-bun run index.ts
+bun start
 ```
 
-This project was created using `bun init` in bun v1.1.10. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
diff --git a/example/package.json b/example/package.json
@@ -3,7 +3,7 @@
     "module": "server.ts",
     "type": "module",
     "scripts": {
-        "start": "bun server/index.ts --watch",
+        "start": "bun --watch server/index.ts",
         "bundle": "bun build --outdir dist client/app.tsx"
     },
     "devDependencies": {