Skip to content

Commit a305662

Browse files
committed
feat: update README and README.zh-CN to reflect new logo and tech stack changes
1 parent 2df02fe commit a305662

2 files changed

Lines changed: 36 additions & 66 deletions

File tree

‎README.md‎

Lines changed: 18 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
<p align="center">> Logo design in progress (PR Welcome)</p>
2-
3-
<h1 align="center">Mind Flayer</h1>
4-
5-
<p align="center">👻 A powerful desktop AI assistant app built with Tauri, React, Vite7, TS and more!</p>
1+
# 👻 Mind Flayer
62

73
<p align="center">
8-
English | <a href="README.zh-CN.md">简体中文</a>
4+
<img src="src-tauri/icons/256x256.png" width="128" alt="Mind Flayer Logo" />
95
</p>
106

7+
<p align="center">A powerful desktop AI assistant app built with Tauri, React, Vercel AI SDK and more!</p>
8+
119
<br>
1210

1311
<div align="center">
@@ -16,54 +14,41 @@
1614
<img src="https://img.shields.io/badge/Rust-c57c54?logo=rust&logoColor=E34F26">
1715
<img src="https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=fff">
1816
<img src="https://img.shields.io/badge/React%2019-2C4F7C?logo=react&logoColor=61DAFB">
19-
<img src="https://img.shields.io/badge/Tailwind%20CSS-%2338B2AC.svg?logo=tailwind-css&logoColor=white">
17+
<img src="https://img.shields.io/badge/Vercel%20AI%20SDK-000000?logo=vercel&logoColor=white">
2018
<img src="https://img.shields.io/badge/shadcn/ui-000000?logo=shadcnui&logoColor=fff">
19+
<img src="https://img.shields.io/badge/Tailwind%20CSS-%2338B2AC.svg?logo=tailwind-css&logoColor=white">
2120
<img src="https://img.shields.io/badge/Biome-60A5FA?logo=biome&logoColor=fff">
2221
<img src="https://img.shields.io/badge/Vite7-646CFF?logo=vite&logoColor=fff">
23-
<img src="https://img.shields.io/badge/vitest-6E9F18?logo=vitest&logoColor=fff">
22+
<img src="https://img.shields.io/badge/Vitest4-6E9F18?logo=vitest&logoColor=fff">
2423
<img src="https://img.shields.io/badge/pnpm10-F69220?logo=pnpm&logoColor=fff">
2524
<img src="https://img.shields.io/badge/lefthook-E93d30?logo=lefthook&logoColor=fff">
2625
</p>
2726
</div>
2827

28+
<p align="center">
29+
English | <a href="README.zh-CN.md">简体中文</a>
30+
</p>
31+
2932
<br>
3033

3134
## Screenshots
3235

3336
<p align="center">
34-
<img height="400" alt="App Screenshot 1" src="https://github.com/user-attachments/assets/e6ca86e8-c854-4705-88de-130bf2f88051" />
35-
<img height="400" alt="App Screenshot 2" src="https://github.com/user-attachments/assets/1e7e3569-17be-4654-b2b3-20407d34871c" />
36-
37-
<img height="400" alt="App Screenshot 3" src="https://github.com/user-attachments/assets/11ad5a84-cdee-4833-a1f5-c4212033ea25" />
38-
<img height="400" alt="App Screenshot 4" src="https://github.com/user-attachments/assets/361c2f13-3758-456f-8fee-ae3b8c7b7630" />
39-
<img height="400" alt="App Screenshot 5" src="https://github.com/user-attachments/assets/32815892-2a2f-4902-98e6-ae51d27133ac" />
37+
<img height="500" alt="App Screenshot 1" src="preview/img-1.png" />
4038
</p>
4139

4240
<br>
4341

44-
## Getting Started
45-
46-
### Install Dependencies
47-
48-
```sh
49-
pnpm install
50-
```
51-
52-
### Dev
53-
54-
Start the development server (launches both frontend and Tauri app):
42+
## Development
5543

5644
```sh
57-
pnpm dev
45+
pnpm install # Install all dependencies
46+
pnpm dev # Start development (frontend + Tauri)
47+
pnpm test # Run all tests (vitest + cargo)
48+
pnpm build # Build for production
5849
```
5950

60-
### Build
61-
62-
Build for production:
63-
64-
```sh
65-
pnpm build
66-
```
51+
> **Note:** more
6752
6853
<br>
6954

‎README.zh-CN.md‎

Lines changed: 18 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
<p align="center">> Logo 设计中(欢迎 PR)</p>
2-
3-
<h1 align="center">Mind Flayer</h1>
4-
5-
<p align="center">👻 一个强大的开源跨平台桌面 AI 助手应用,使用 Tauri、React、Vite7、TS、Tailwind CSS 等技术构建!</p>
1+
# 👻 Mind Flayer
62

73
<p align="center">
8-
<a href="README.md">English</a> | 简体中文
4+
<img src="src-tauri/icons/256x256.png" width="128" alt="Mind Flayer Logo" />
95
</p>
106

7+
<p align="center">一个优雅简洁的桌面 AI 助手应用,基于 Tauri、React、Vercel AI SDK 等技术构建!</p>
8+
119
<br>
1210

1311
<div align="center">
@@ -16,54 +14,41 @@
1614
<img src="https://img.shields.io/badge/Rust-c57c54?logo=rust&logoColor=E34F26">
1715
<img src="https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=fff">
1816
<img src="https://img.shields.io/badge/React%2019-2C4F7C?logo=react&logoColor=61DAFB">
19-
<img src="https://img.shields.io/badge/Tailwind%20CSS-%2338B2AC.svg?logo=tailwind-css&logoColor=white">
17+
<img src="https://img.shields.io/badge/Vercel%20AI%20SDK-000000?logo=vercel&logoColor=white">
2018
<img src="https://img.shields.io/badge/shadcn/ui-000000?logo=shadcnui&logoColor=fff">
19+
<img src="https://img.shields.io/badge/Tailwind%20CSS-%2338B2AC.svg?logo=tailwind-css&logoColor=white">
2120
<img src="https://img.shields.io/badge/Biome-60A5FA?logo=biome&logoColor=fff">
2221
<img src="https://img.shields.io/badge/Vite7-646CFF?logo=vite&logoColor=fff">
23-
<img src="https://img.shields.io/badge/vitest-6E9F18?logo=vitest&logoColor=fff">
22+
<img src="https://img.shields.io/badge/Vitest4-6E9F18?logo=vitest&logoColor=fff">
2423
<img src="https://img.shields.io/badge/pnpm10-F69220?logo=pnpm&logoColor=fff">
2524
<img src="https://img.shields.io/badge/lefthook-E93d30?logo=lefthook&logoColor=fff">
2625
</p>
2726
</div>
2827

28+
<p align="center">
29+
<a href="README.md">English</a> | 简体中文
30+
</p>
31+
2932
<br>
3033

3134
## 截图
3235

3336
<p align="center">
34-
<img height="400" alt="应用截图 1" src="https://github.com/user-attachments/assets/e6ca86e8-c854-4705-88de-130bf2f88051" />
35-
<img height="400" alt="应用截图 2" src="https://github.com/user-attachments/assets/1e7e3569-17be-4654-b2b3-20407d34871c" />
36-
37-
<img height="400" alt="应用截图 3" src="https://github.com/user-attachments/assets/11ad5a84-cdee-4833-a1f5-c4212033ea25" />
38-
<img height="400" alt="应用截图 4" src="https://github.com/user-attachments/assets/361c2f13-3758-456f-8fee-ae3b8c7b7630" />
39-
<img height="400" alt="应用截图 5" src="https://github.com/user-attachments/assets/32815892-2a2f-4902-98e6-ae51d27133ac" />
37+
<img height="500" alt="应用截图 1" src="preview/img-1.png" />
4038
</p>
4139

4240
<br>
4341

44-
## 快速开始
45-
46-
### 安装依赖
47-
48-
```sh
49-
pnpm install
50-
```
51-
52-
### 开发
53-
54-
启动开发服务器(同时启动前端和 Tauri 应用):
42+
## 开发
5543

5644
```sh
57-
pnpm dev
45+
pnpm install # 安装全部依赖
46+
pnpm dev # 启动开发环境(前端 + Tauri)
47+
pnpm test # 运行全部测试(vitest + cargo)
48+
pnpm build # 构建生产版本
5849
```
5950

60-
### 构建
61-
62-
生产环境构建:
63-
64-
```sh
65-
pnpm build
66-
```
51+
> **说明:** more
6752
6853
<br>
6954

0 commit comments

Comments
 (0)