1 files changed, 67 insertions, 4 deletions

diff --git a/README.md b/README.md
index 7ff6645..5ee4569 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,71 @@
-# logshader
+# logshader (essentials)
 
-> 水系 `logger` 着色器
+[Demo Preview](https://logshader.hydroroll.team/)
 
+## Project setup
 
-#### site preview
+```
+# yarn
+yarn
 
-https://logshader.hydroroll.team 
\ No newline at end of file
+# npm
+npm install
+
+# pnpm
+pnpm install
+
+# bun 
+bun install
+```
+
+### Compiles and hot-reloads for development
+
+```
+# yarn
+yarn dev
+
+# npm
+npm run dev
+
+# pnpm
+pnpm dev
+
+# bun 
+bun run dev
+```
+
+### Compiles and minifies for production
+
+```
+# yarn
+yarn build
+
+# npm
+npm run build
+
+# pnpm
+pnpm build
+
+# bun 
+bun run build
+```
+
+### Lints and fixes files
+
+```
+# yarn
+yarn lint
+
+# npm
+npm run lint
+
+# pnpm
+pnpm lint
+
+# bun 
+bun run lint
+```
+
+### Customize configuration
+
+See [Configuration Reference](https://vitejs.dev/config/).