Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ylzon committed May 6, 2024
1 parent 968ddcb commit 19da77b
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,30 @@
# 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

```bash
npm install @fiagram/react
```

```bash
pnpm add @fiagram/react
```

### Todo
React
* [x] 支持 i18n 多语言
* [x] 支持 CSS var
* [ ] 支持黑白主题
* [ ] 预置FlowChart、Topology等常用图形

Vue
* [ ] WIP

### React Usage

```javascript
Expand Down Expand Up @@ -46,6 +61,4 @@ const App = () => {
export default App;
```

### Todo

* [ ] TODO

0 comments on commit 19da77b

Please sign in to comment.