From 7c7be787497fa124d08532112a7e5c80e48615b9 Mon Sep 17 00:00:00 2001
From: Andy Yen <38731840+onlyjackfrost@users.noreply.github.com>
Date: Wed, 22 May 2024 14:44:12 +0800
Subject: [PATCH] chore: Update README.md and add migration instructions (#294)

---
 wren-ui/README.md | 31 ++++++++++++++++++++++++++-----
 1 file changed, 26 insertions(+), 5 deletions(-)

diff --git a/wren-ui/README.md b/wren-ui/README.md
index c4033664f..e3b0de90d 100644
--- a/wren-ui/README.md
+++ b/wren-ui/README.md
@@ -2,16 +2,37 @@ This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next
 
 ## Getting Started
 
-First, run the development server:
+Step 1. Make sure your node version is 16
+```bash
+node -v
+```
+
+Step 2. Install dependencies:
 
 ```bash
-npm run dev
+yarn 
+```
+
+Step 3. Run migrations:
+
+```bash
+# Windows
+SET DB_TYPE=sqlite
+
+# Linux or MacOS
+export DB_TYPE=sqlite
+
+yarn migrate
 # or
+npm run migrate
+```
+
+Step 4. Run the development server:
+
+```bash
 yarn dev
 # or
-pnpm dev
-# or
-bun dev
+npm run dev
 ```
 
 Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.