From b23e074ba0efae8c3c4e06fc6eff29853982525a Mon Sep 17 00:00:00 2001
From: AnotiaWang <anotia0202@gmail.com>
Date: Thu, 13 Feb 2025 10:52:35 +0800
Subject: [PATCH] chore: update README for clearer instructions

---
 README.md | 87 +++++++++++++++++++++----------------------------------
 1 file changed, 33 insertions(+), 54 deletions(-)

diff --git a/README.md b/README.md
index 983ec24..a94fb9b 100644
--- a/README.md
+++ b/README.md
@@ -6,32 +6,47 @@ Features:
 
 - Stream AI responses for realtime feedback
 - Viasualization of the research process using a tree structure
+- Export research report as PDF
 - Bring Your Own API Key: Everything (config, API requests, ...) happens in your browser
 
-Available providers currently:
+Currently available providers:
 - AI: OpenAI compatible
 - Web Search: Tavily (similar to Firecrawl, but with more free quota (1000 credits / month))
 
-> Note: The project is currently WIP, expect bugs.
+Please give a 🌟 Star if you like this project!
 
-https://github.com/user-attachments/assets/2f5a6f9c-18d1-4d40-9822-2de260d55dab
+<video src="https://github.com/user-attachments/assets/2f5a6f9c-18d1-4d40-9822-2de260d55dab" controls></video>
 
-## Setup
+## How to use
+
+Live demo: <a href="https://deep-research.ataw.top" target="_blank">https://deep-research.ataw.top</a>
+
+### Self hosted
+
+Use pre-built Docker image:
+```bash
+docker run -p 3000:3000 --name deep-research-web -d anotia/deep-research-web:latest
+```
+
+Use self-built Docker image:
+```
+git clone https://github.com/AnotiaWang/deep-research-web-ui
+cd deep-research-web-ui
+docker build -t deep-research-web .
+docker run -p 3000:3000 --name deep-research-web -d deep-research-web
+```
+
+---
+
+## Developing
+
+### Setup
 
 Make sure to install dependencies:
 
 ```bash
-# npm
-npm install
-
 # pnpm
 pnpm install
-
-# yarn
-yarn install
-
-# bun
-bun install
 ```
 
 ## Development Server
@@ -39,63 +54,27 @@ bun install
 Start the development server on `http://localhost:3000`:
 
 ```bash
-# npm
-npm run dev
-
-# pnpm
 pnpm dev
-
-# yarn
-yarn dev
-
-# bun
-bun run dev
 ```
 
 ## Production
 
 Build the application for production:
 
+If you want to deploy a SSR application:
 ```bash
-# npm
-npm run build
-
-# pnpm
 pnpm build
+```
 
-# yarn
-yarn build
-
-# bun
-bun run build
+If you want to deploy a static, SSG application:
+```bash
+pnpm generate
 ```
 
 Locally preview production build:
 
 ```bash
-# npm
-npm run preview
-
-# pnpm
 pnpm preview
-
-# yarn
-yarn preview
-
-# bun
-bun run preview
-```
-
-### Docker
-
-Build the Docker image:
-```
-docker build -t deep-research-web .
-```
-
-Run the Docker image:
-```
-docker run -p 3000:3000 deep-research-web
 ```
 
 Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.