update README

Privoce · Jan 24, 2025 · 87aad40 · 87aad40
1 parent 4d432dd
commit 87aad40
Show file tree

Hide file tree

Showing 3 changed files with 4,406 additions and 8,124 deletions.
diff --git a/README.md b/README.md
@@ -1,29 +1,31 @@
-# Rspress Website
+# GenUI Book
 
-## Setup
+**👷The document is under rapid construction... Expected to be completed on January 30, 2025**
 
-Install the dependencies:
+## Guide
 
-```bash
-npm install
-```
+- [x] overview
+- [x] introduction
+- [x] tools
+- [x] plugins
 
-## Get Started
+## Tutorial
 
-Start the dev server:
+- [x] overview
+- [x] quick-start
+- [x] ract
+- [x] project-structure
+- [ ] template
+- [ ] style
+- [ ] script
 
-```bash
-npm run dev
-```
+## Config
 
-Build the website for production:
 
-```bash
-npm run build
-```
+## Components
 
-Preview the production build locally:
+## Examples
 
-```bash
-npm run preview
-```
+## Tools
+
+## API