From 19da77b09ebd060f738f98da0b82f45376ac7470 Mon Sep 17 00:00:00 2001
From: ylzon <yanlezhong@gmail.com>
Date: Mon, 6 May 2024 22:56:08 +0800
Subject: [PATCH] docs: update README

---
 README.md | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index a61cc2b..6f73695 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,9 @@
-# Fiagram
+![fiagram-logo.png](docs/public/fiagram-logo.png)
 
-F Word React + TypeScript diagram library that uses SVG and HTML for rendering
 
-![fiagram-logo.png](docs/public/fiagram-logo.png)
+基于 SVG + D3.js，可快速构建出拓扑图、流程图等可视化图形组件
+
+> WIP 项目，目前仅支持 React
 
 ### Installation
 
@@ -10,6 +11,20 @@ F Word React + TypeScript diagram library that uses SVG and HTML for rendering
 npm install @fiagram/react
 ```
 
+```bash
+pnpm add @fiagram/react
+```
+
+### Todo
+React 
+* [x] 支持 i18n 多语言
+* [x] 支持 CSS var
+* [ ] 支持黑白主题
+* [ ] 预置FlowChart、Topology等常用图形
+
+Vue
+* [ ] WIP
+
 ### React Usage
 
 ```javascript
@@ -46,6 +61,4 @@ const App = () => {
 export default App;
 ```
 
-### Todo
 
-* [ ] TODO