Skip to content

Commit f75cbfb

Browse files
committed
docs: update readme
1 parent f3be444 commit f75cbfb

File tree

1 file changed

+18
-26
lines changed

1 file changed

+18
-26
lines changed

packages/react-vchart/README.md

+18-26
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# @visactor/react-vchart
22

3-
`@visactor/react-vchart` 是由 [VisActor](visactor.io) 为您提供的 React 封装版本 VChart 图表库。它提供了一系列易于使用的 React 组件,用于方便的在 React 开发环境中创建各种类型的图表,包括折线图、柱状图、饼图等。`@visactor/react-vchart` 的组件具有高度的可定制性和可扩展性,可以通过传递不同的参数和配置来实现不同的图表效果。
3+
`@visactor/react-vchart` is a React wrapper version of the VChart library provided by [VisActor](visactor.io). It offers a series of easy-to-use React components for creating various types of charts in a React development environment, including line charts, bar charts, pie charts, and more. The components in `@visactor/react-vchart` are highly customizable and extensible, allowing you to achieve different chart effects through various parameters and configurations.
44

5-
`@visactor/react-vchart` 的主要特点包括:
5+
Key features of `@visactor/react-vchart` include:
66

7-
- **易于使用**`@visactor/react-vchart` 提供了一系列易于使用的 React 组件,可以快速创建各种类型的图表。
8-
- **可定制性强**`@visactor/react-vchart` 的组件具有高度的可定制性,可以通过传递不同的参数和配置来实现不同的图表效果。
9-
- **可扩展性强**`@visactor/react-vchart` 的组件可以轻松地扩展和定制,可以根据需要添加新的功能和特性。
10-
- **兼容性好**`@visactor/react-vchart` 完全继承了 VChart 的可视化能力,可以在不同的浏览器和设备上运行。
11-
- **支持多种图表类型**`@visactor/react-vchart` 支持多种类型的图表,包括折线图、柱状图、饼图、雷达图等。
7+
- **Easy to Use**: `@visactor/react-vchart` provides a series of user-friendly React components for quickly creating various types of charts.
8+
- **Highly Customizable**: The components in `@visactor/react-vchart` are highly customizable, allowing you to achieve different chart effects through various parameters and configurations.
9+
- **Extensible**: `@visactor/react-vchart` components can be easily extended and customized, allowing you to add new functionalities and features as needed.
10+
- **Good Compatibility**: `@visactor/react-vchart` fully inherits VChart's visualization capabilities and can run on different browsers and devices.
11+
- **Support for Multiple Chart Types**: `@visactor/react-vchart` supports various types of charts, including line charts, bar charts, pie charts, radar charts, and more.
1212

13-
`@visactor/react-vchart` 在能力上完全对齐 VChart,并且 API 配置也与 VChart 几乎一致,关于图表的定义和配置可参考[VChart](https://www.visactor.io/vchart)
13+
`@visactor/react-vchart` is fully aligned with VChart in terms of capabilities, and its API configuration is almost identical to VChart. For chart definitions and configurations, please refer to [VChart](https://www.visactor.io/vchart).
1414

15-
## 开发指引
15+
## Development Guide
1616

1717
### Build
1818

@@ -35,20 +35,12 @@ $ cd packages/react-vchart
3535
$ rushx start
3636
```
3737

38-
## 文档指引
39-
40-
项目文档位于 `@visactor/react-vchart` 目录中的 [docs](./docs) 路径。
41-
42-
1. [快速开始](./docs/1.%20%E5%BF%AB%E9%80%9F%E5%BC%80%E5%A7%8B.md)
43-
- 环境要求
44-
- 安装
45-
- 引入 `@visactor/react-vchart`
46-
- 绘制一个简单的柱状图
47-
2. 入门
48-
- [API 设计](./docs/2.1%20API%E8%AE%BE%E8%AE%A1.md)
49-
- [统一图表标签](./docs//2.2%20%E7%BB%9F%E4%B8%80%E5%9B%BE%E8%A1%A8%E6%A0%87%E7%AD%BE.md)
50-
- [语法化标签](./docs/2.3%20%E8%AF%AD%E6%B3%95%E5%8C%96%E6%A0%87%E7%AD%BE.md)
51-
3. [事件交互](./docs/3.%20%E4%BA%8B%E4%BB%B6%E4%BA%A4%E4%BA%92.md)
52-
4. [主题样式](./docs/4.%20%E4%B8%BB%E9%A2%98%E6%A0%B7%E5%BC%8F.md)
53-
5. [FAQ](./docs/5.%20FAQ.md)
54-
6. [更新日志](./docs/6.%20%E6%9B%B4%E6%96%B0%E6%97%A5%E5%BF%97.md)
38+
## Documentation Guide
39+
40+
[guide](https://github.com/VisActor/VChart/blob/develop/docs/assets/guide/zh/tutorial_docs/Cross-terminal_and_Developer_Ecology/react.md)
41+
42+
[demo](https://github.com/VisActor/VChart/tree/develop/docs/assets/examples-react)
43+
44+
[online guide](https://www.visactor.io/vchart/guide/tutorial_docs/Cross-terminal_and_Developer_Ecology/react)
45+
46+
[online demo](https://www.visactor.io/vchart/example-react)

0 commit comments

Comments
 (0)