Skip to content

Commit

Permalink
docs: 完善 README.md 文档
Browse files Browse the repository at this point in the history
  • Loading branch information
boyongjiong committed Aug 7, 2024
1 parent 4cf0358 commit 5aaaa7a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 27 deletions.
30 changes: 15 additions & 15 deletions README.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ LogicFlow is a flowchart editing framework , providing a series of functions nec

## Features

- 高可定制性:自定义能力,支持 SVG、HTML、React、Vue 等自定义节点;边的富文本编辑
- 丰富的插件
- 可视化模型:MVVM
- 自执行引擎
- 数据可转换:BPMN、...
- High customizability:With the intuitive visual interface provided by LogicFlow, users can easily create, edit, and manage complex logical flowcharts.
- Rich Plug-ins: Built-in rich plug-ins, users can also customize complex plug-ins according to their own needs to achieve business requirements.
- The Visualization model:Users can customize nodes, connectors, and styles to suit their needs, creating custom logical flowcharts that match specific use cases.
- Self-executing engine: The execution engine supports browser-side flow chart logic, providing new ideas for code-free execution.
- Data convertible:Supports the conversion of LogicFlow data to BPMN, Turbo, and other backend execution engine data structures.

## Installation

Expand Down Expand Up @@ -62,14 +62,14 @@ const data = {
type: 'rect',
x: 100,
y: 200,
text: '矩形节点',
text: 'Rect Node',
},
{
id: '50',
type: 'circle',
x: 300,
y: 400,
text: '圆形节点',
text: 'Circle Node',
},
],
//
Expand All @@ -93,17 +93,17 @@ lf.render(data);

## Links

[Official Website](https://site.logic-flow.cn/)
[Official Website](https://site.logic-flow.cn/en/)

- [Getting Started](https://site.logic-flow.cn/tutorial/getting-started)
- [Examples](https://site.logic-flow.cn/examples)
- [Articles](https://site.logic-flow.cn/article/article01)
- [Getting Started](https://site.logic-flow.cn/en/tutorial/get-started)
- [Examples](https://site.logic-flow.cn/en/examples)
- [Articles](https://site.logic-flow.cn/en/article/architecture-of-logicflow)

[CHANGELOG]()
[FAQs]()
[Issue Template]()
---
- [CHANGELOG](https://github.com/didi/LogicFlow/releases)
- [Issue Template](https://github.com/didi/LogicFlow/issues/new/choose)

## Development
## [Development](/CONTRIBUTING.en-US.md)

```shell
# install deps and build
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ LogicFlow 是一款流程图编辑框架,提供了一系列流程图交互、

## 核心能力

- 高可定制性:自定义能力,支持 SVG、HTML、React、Vue 等自定义节点;边的富文本编辑
- 丰富的插件
- 可视化模型:MVVM
- 自执行引擎
- 数据可转换:BPMN、...
- 可视化模型:通过 LogicFlow 提供的直观可视化界面,用户可以轻松创建、编辑和管理复杂的逻辑流程图。
- 高可定制性:用户可以根据自己的需要定制节点、连接器和样式,创建符合特定用例的定制逻辑流程图。
- 灵活易拓展: 内置提供丰富的插件,用户也可根据自身需求定制复杂插件实现业务需求。
- 自执行引擎: 执行引擎支持浏览器端执行流程图逻辑,为无代码执行提供新思路。
- 数据可转换:支持 LogicFlow 数据与 BPMN、Turbo 等各种后端执行引擎数据结构转换能力。

## 安装

Expand Down Expand Up @@ -94,15 +94,15 @@ lf.render(data);

[官方文档](https://site.logic-flow.cn/)

- [快速上手](https://site.logic-flow.cn/tutorial/getting-started)
- [示例](https://site.logic-flow.cn/examples)
- [文章](https://site.logic-flow.cn/article/article01)
- [快速上手](https://site.logic-flow.cn/tutorial/get-started)
- [图表示例](https://site.logic-flow.cn/examples)
- [相关文章](https://site.logic-flow.cn/article/architecture-of-logicflow)

[更新日志]()
[常见问题]()
[issue模板]()
---
- [更新日志](https://github.com/didi/LogicFlow/releases)
- [issue模板](https://github.com/didi/LogicFlow/issues/new/choose)

## 本地开发
## [本地开发](/CONTRIBUTING.md)

```shell
# 安装项目依赖和初始化构建
Expand Down

0 comments on commit 5aaaa7a

Please sign in to comment.