mirror of
https://gitee.com/antv/g6.git
synced 2024-11-30 02:38:20 +08:00
chore(README): update README
This commit is contained in:
yilin.qyl
parent
567203f32e
commit
d6045cb53f
@ -9,20 +9,16 @@
|
||||
|
||||
[English README](README.md)
|
||||
|
||||
G6 是一个图可视化框架。它提供了一套图可视化的基础设置，能帮助开发者搭建属于自己的图 **图分析** 应用或是 **图编辑器** 应用。
|
||||
|
||||
**注意**： G6 3.0 版本带来了重大更新，目前正在beta测试中。欢迎开发者们试用，详情请见 [3.x文档](https://www.yuque.com/antv/g6/xauk5e)。
|
||||
|
||||
[2.x 完整文档](https://www.yuque.com/antv/g6/introduce)
|
||||
G6 是一个图可视化框架。它提供了一套图可视化的基础设置，能帮助开发者搭建属于自己的图 **图分析** 应用或是 **图编辑器** 应用。 详情请见[开发文档](https://www.yuque.com/antv/g6/intro)。
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/6113694/44995293-02858600-afd5-11e8-840c-349e4730d63d.gif" height=150><img src="https://cdn.nlark.com/yuque/0/2018/gif/93506/1535955277773-840190f8-836a-4bd6-875a-b3a18e6cebf1.gif" height=150><img src="https://user-images.githubusercontent.com/6113694/44995332-2ba61680-afd5-11e8-8cab-db0e9d08ceb7.gif" height=150>
|
||||
|
||||
<img src="https://gw.alipayobjects.com/zos/rmsportal/HQxYguinFOMIXrGQOABY.gif" height=150><img src="https://gw.alipayobjects.com/zos/rmsportal/nAugyFgrbrUWPmDIDiQm.gif" height=150>
|
||||
<img src="https://gw.alipayobjects.com/zos/rmsportal/HQxYguinFOMIXrGQOABY.gif" height=150><img src="https://gw.alipayobjects.com/zos/rmsportal/nAugyFgrbrUWPmDIDiQm.gif" height=150><img src="https://cdn.nlark.com/yuque/0/2019/gif/174835/1552990627466-92a4ce23-79b2-4930-ab05-6478b56ce880.gif" height=150>
|
||||
|
||||
## [G6-Editor](https://yuque.com/antv/g6-editor)
|
||||
|
||||
<img src="https://gw.alipayobjects.com/zos/rmsportal/nzmycBewjfxKDbepTDlT.gif" width=560>
|
||||
<img src="https://gw.alipayobjects.com/zos/rmsportal/WVqnbgJmamdahbAuDpBL.gif" width=560>
|
||||
<img src="https://cdn.nlark.com/yuque/0/2018/png/93506/1542618842515-6655c4aa-5345-40b5-b496-236f0c89c8f3.png" width=560>
|
||||
|
||||
## G6-Analyzer [coming soon]
|
||||
|
||||
@ -40,7 +36,7 @@ $ npm install @antv/g6
|
||||
```js
|
||||
import G6 from '@antv/g6';
|
||||
|
||||
const data = {
|
||||
const data = {
|
||||
nodes: [{
|
||||
id: 'node1',
|
||||
x: 100,
|
||||
@ -58,7 +54,16 @@ const data = {
|
||||
const graph = new G6.Graph({
|
||||
container: 'mountNode',
|
||||
width: 500,
|
||||
height: 500
|
||||
height: 500,
|
||||
nodeStyle: {
|
||||
default: {
|
||||
fill: '#40a9ff',
|
||||
stroke: '#096dd9'
|
||||
}
|
||||
},
|
||||
edgeStyle: {
|
||||
default: { stroke: '#A3B1BF' }
|
||||
}
|
||||
});
|
||||
graph.read(data);
|
||||
```
|
||||
@ -77,20 +82,10 @@ $ npm run dev
|
||||
|
||||
## 如何贡献
|
||||
|
||||
Please let us know how can we help. Do check out [issues](https://github.com/antvis/g6/issues) for bug reports or suggestions first.
|
||||
|
||||
请让我们知道您要解决或贡献什么，所以在贡献之前请先提交 [issues](https://github.com/antvis/g6/issues) 描述 bug 或建议。
|
||||
|
||||
成为一个贡献者前请阅读 [代码贡献规范](https://github.com/antvis/g6/blob/master/CONTRIBUTING.zh-CN.md).
|
||||
|
||||
## 体验改进计划说明
|
||||
为了更好服务用户，G6 会将 URL 和版本信息发送回 AntV 服务器：
|
||||
https://kcart.alipay.com/web/bi.do
|
||||
除了 URL 与 G6 版本信息外，不会收集任何其他信息。如有担心，可以通过下面的代码关闭：
|
||||
```js
|
||||
// 关闭 G6 的体验改进计划打点请求
|
||||
G6.track(false)
|
||||
```
|
||||
## License
|
||||
|
||||
[MIT license](./LICENSE).
|
||||
|
||||
34
README.md
34
README.md
@ -10,20 +10,20 @@
|
||||
|
||||
[中文 README](README-zh_CN.md)
|
||||
|
||||
G6 is a graph visualization framework which provides a set of basic mechanisms. Developers are able to build graph visualization **analysis** application or graph visualization **modeling** application easily.
|
||||
|
||||
**notice**: G6 3.0 version is now beta testing which brings many breaking changes and new features. For more information please check [3.0 documentation](https://www.yuque.com/antv/g6/xauk5e).
|
||||
|
||||
See also [ 2.x Full documentation](https://www.yuque.com/antv/g6-en)
|
||||
G6 is a graph visualization framework which provides a set of basic mechanisms. Developers are able to build graph visualization **analysis** application or graph visualization **modeling** application easily. For more details, please see our [doc](https://www.yuque.com/antv/g6/intro).
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/6113694/44995293-02858600-afd5-11e8-840c-349e4730d63d.gif" height=150><img src="https://cdn.nlark.com/yuque/0/2018/gif/93506/1535955277773-840190f8-836a-4bd6-875a-b3a18e6cebf1.gif" height=150><img src="https://user-images.githubusercontent.com/6113694/44995332-2ba61680-afd5-11e8-8cab-db0e9d08ceb7.gif" height=150>
|
||||
|
||||
<img src="https://gw.alipayobjects.com/zos/rmsportal/HQxYguinFOMIXrGQOABY.gif" height=150><img src="https://gw.alipayobjects.com/zos/rmsportal/nAugyFgrbrUWPmDIDiQm.gif" height=150>
|
||||
<img src="https://gw.alipayobjects.com/zos/rmsportal/HQxYguinFOMIXrGQOABY.gif" height=150><img src="https://gw.alipayobjects.com/zos/rmsportal/nAugyFgrbrUWPmDIDiQm.gif" height=150><img src="https://cdn.nlark.com/yuque/0/2019/gif/174835/1552990627466-92a4ce23-79b2-4930-ab05-6478b56ce880.gif" height=150>
|
||||
|
||||
## [G6-Editor](https://yuque.com/antv/g6-editor)
|
||||
|
||||
<img src="https://gw.alipayobjects.com/zos/rmsportal/nzmycBewjfxKDbepTDlT.gif" width=560>
|
||||
<img src="https://gw.alipayobjects.com/zos/rmsportal/WVqnbgJmamdahbAuDpBL.gif" width=560>
|
||||
<img src="https://cdn.nlark.com/yuque/0/2018/png/93506/1542618842515-6655c4aa-5345-40b5-b496-236f0c89c8f3.png" width=560>
|
||||
|
||||
## G6-Analyzer [coming soon]
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
@ -55,7 +55,16 @@ const data = {
|
||||
const graph = new G6.Graph({
|
||||
container: 'mountNode',
|
||||
width: 500,
|
||||
height: 500
|
||||
height: 500,
|
||||
nodeStyle: {
|
||||
default: {
|
||||
fill: '#40a9ff',
|
||||
stroke: '#096dd9'
|
||||
}
|
||||
},
|
||||
edgeStyle: {
|
||||
default: { stroke: '#A3B1BF' }
|
||||
}
|
||||
});
|
||||
graph.read(data);
|
||||
```
|
||||
@ -78,15 +87,6 @@ Please let us know how can we help. Do check out [issues](https://github.com/ant
|
||||
|
||||
To become a contributor, please follow our [contributing guide](https://github.com/antvis/g6/blob/master/CONTRIBUTING.md).
|
||||
|
||||
## Experience Improvement
|
||||
To better serve the users, G6 sends URL and version infomation back to AntV server:
|
||||
https://kcart.alipay.com/web/bi.do
|
||||
We will never collect other information. If you are worried about that, close it by:
|
||||
|
||||
```js
|
||||
G6.track(false);
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
[MIT license](./LICENSE).
|
||||
|
||||
Loading…
Reference in New Issue
Block a user