From fb5128c1f85957e8ddcc31f371b03270aa39d4fe Mon Sep 17 00:00:00 2001
From: Majoson <42291113+majoson-chen@users.noreply.github.com>
Date: Wed, 8 May 2024 21:57:22 +0800
Subject: [PATCH] update: README.md

---
 .github/workflows/vitepress.yml |  1 +
 README.md                       | 46 ++++++++++++---------------------
 2 files changed, 18 insertions(+), 29 deletions(-)

diff --git a/.github/workflows/vitepress.yml b/.github/workflows/vitepress.yml
index b550e79..ca3be44 100644
--- a/.github/workflows/vitepress.yml
+++ b/.github/workflows/vitepress.yml
@@ -35,4 +35,5 @@ jobs:
         with:
           github_token: ${{ secrets.ACCESS_TOKEN }}
           publish_dir: ./dist
+          cname: suiue.suifans.org
 
diff --git a/README.md b/README.md
index d73b9db..84792f4 100644
--- a/README.md
+++ b/README.md
@@ -2,40 +2,28 @@
 
 > the vue dapp-kit for sui
 
-**本项目目前处于初期预览状态，可能随时会发生改变，请谨慎用于生产环境！**
 
-## install
+## features
 
-```bash
-npm install @suifans/suiue
-```
+- vue localization style
+- Integrated practical functions
+- Personalized support
+- More configuration options, and it also works out of the box!
 
-## examples
-```typescript
+## documentation
 
-const {
-    signPresonalMessage,
-    signAndExecuteTransactionBlock,
-    SignTransactionBlock,
-} = useWalletAction()
+click [here](https://suiue.suifans.org/)
 
-// if wallet is not connected, it will open the wallet connect modal and continue
-signAndExecuteTransactionBlock(...)
+## demo
 
-
-const {
-    address,
-    getAllCoins,
-    getSuiCoin
-} = useWalletInfo()
-```
-
-请看 [suiue-example](./demo/App.vue)
+click [here](./packages/demo)
 
 ## TODO
-- [ ] 改善ts
-- [ ] 添加文档
-- [ ] 完善demo
-- [ ] 添加更多实用方法
-- [ ] 添加内置UI组件
-- [ ] 嵌入式SUI钱包
\ No newline at end of file
+- [x] Improve ts
+- [x] Add documentation
+- [x] Add demo
+- [x] Built-in UI components
+- [ ] Customizable UI components
+- [ ] Fully unit-test
+- [ ] More practical functions
+- [ ] embedded sui wallet
\ No newline at end of file