Skip to content

Commit

Permalink
update: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
majoson-chen committed May 8, 2024
1 parent 0dada5c commit fb5128c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 29 deletions.
1 change: 1 addition & 0 deletions .github/workflows/vitepress.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,5 @@ jobs:
with:
github_token: ${{ secrets.ACCESS_TOKEN }}
publish_dir: ./dist
cname: suiue.suifans.org

46 changes: 17 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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钱包
- [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

0 comments on commit fb5128c

Please sign in to comment.