Skip to content

Commit 48302bd

Browse files
committed
docs: update readme
1 parent a69cbbf commit 48302bd

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,32 @@
1+
![Vite DevTools](https://github.com/user-attachments/assets/ac930792-ba80-4eb3-9121-66fcd59dc2a8)
2+
13
# Vite DevTools
24

5+
Vite DevTools is a set of tools for visualizing the internal state and build analysis for Vite and Rolldown (currently only work with [`rolldown-vite`](https://github.com/vitejs/rolldown-vite)).
6+
37
> [!IMPORTANT]
4-
> This project is still in development. Not yet usable.
8+
> This project is still in development. Not yet usable. You may preview it by building this project from source.
9+
10+
## 🏗️ Project Progress
11+
12+
State: **🚧 Work in progress**
513

6-
### Development Guide
14+
We are currently focusing on get the basic data visualization working for **Vite-Rolldown's build mode**. Dev mode will be delayed for later until Vite get the full-bundler dev mode.
15+
16+
You can check the [TODO list](https://github.com/vitejs/devtools/issues/9) if you are interested in helping out.
17+
18+
## 🧑‍💻 Development Guide
719

820
Currently Vite DevTools only supports build time inspection, to develop this project, you first need to build itself to get the Rolldown meta for testing.
921

10-
Run `pnpm build` first and then run `pnpm dev` to start the dev server.
22+
- `pnpm install` to install dependencies
23+
- `pnpm build` first to get the Rolldown logs under `./packages/devtools/.rolldown` folder
24+
- `pnpm dev` to start the dev server
25+
26+
As the data interface between Rolldown is not yet stable, and breaking changes are expected. We locked the Rolldown version in our `pnpm-workspace.yaml`, which means the published version may not work with the latest Rolldown.
1127

12-
As the data interface between Rolldown is not yet stable, when you pull the latest code, it's recommended remove the `./packages/devtools/.rolldown` folder and run `pnpm build` again to get the latest log.
28+
When pulling the latest commits, it's recommended to remove the `./packages/devtools/.rolldown` folder and run `pnpm build` again to get the latest data format.
1329

14-
## Licenses
30+
## 📄 Licenses
1531

1632
This project is licensed under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)