From a13fbce43102f37fbe411a741ac95966d2a7b889 Mon Sep 17 00:00:00 2001 From: hustcc Date: Fri, 10 Sep 2021 10:37:18 +0800 Subject: [PATCH] docs: update readme (#251) * docs: update readme * chore: add pr template * docs: fix typo --- .github/PULL_REQUEST_TEMPLATE.md | 13 +++++++++++++ LEGAL.md | 7 ------- README.en.md => README.en-US.md | 16 ++++++++-------- README.md | 23 +++++++++++------------ 4 files changed, 32 insertions(+), 27 deletions(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 LEGAL.md rename README.en.md => README.en-US.md (92%) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000000..18574e56a4 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ +### PR includes + + +- [ ] fixed issue #0 +- [ ] add feat, describe your feature +- [ ] add / modify test cases +- [ ] documents, demos + +### Screenshot + +| Before | After | +|----|----| +| ❌ | ✅ | diff --git a/LEGAL.md b/LEGAL.md deleted file mode 100644 index dfc3285823..0000000000 --- a/LEGAL.md +++ /dev/null @@ -1,7 +0,0 @@ -Legal Disclaimer - -Within this source code, the comments in Chinese shall be the original, governing version. Any comment in other languages are for reference only. In the event of any conflict between the Chinese language version comments and other language version comments, the Chinese language version shall prevail. - -法律免责声明 - -关于代码注释部分，中文注释为官方版本，其它语言注释仅做参考。中文注释可能与其它语言注释存在不一致，当中文注释与其它语言注释存在不一致时，请以中文注释为准。 diff --git a/README.en.md b/README.en-US.md similarity index 92% rename from README.en.md rename to README.en-US.md index 3a1909c5c5..ed66145f04 100644 --- a/README.en.md +++ b/README.en-US.md @@ -1,7 +1,7 @@ [简体中文](./README.md) ｜ English -

@antv/s2

+

S2

@@ -11,6 +11,9 @@ Data-driven multi-dimensional analysis table. Version + + + @@ -23,22 +26,18 @@ Data-driven multi-dimensional analysis table. License: MIT@AntV - - -

-S2 is a solution in multi-dimensional cross-analysis tables, which provides data-driven analysis table components and analysis components. - It fills up the vacancy in this field in the industry. By providing the core library, essential components, -demo components and free expansion capabilities allow developers to choose freely based on their real cases, which can be used out of the box and can be used freely. +S2 is a solution in multi-dimensional cross-analysis tables, which provides data-driven analysis table components and analysis components. It fills up the vacancy in this field in the industry. By providing the core library, essential components, demo components and free expansion capabilities allow developers to choose freely based on their real cases, which can be used out of the box and can be used freely. ## ✨ Features + 1. Multi-dimensional cross-analysis: Say goodbye to a single analysis dimension and fully embrace the free combination analysis of any dimension. 2. High performance: It can support rendering in less than 8s under the total amount of millions of data and achieve second-level rendering through partial drilling. 3. High scalability: Support any custom extensions (including but not limited to layout, style, interaction, data hook flow, etc.). @@ -161,7 +160,7 @@ const s2 = new SpreadSheet(container, s2DataCfg, s2options) s2.render() ``` -### 4. 结果 +### 4. Preview ![result](https://gw.alipayobjects.com/zos/antfincdn/rPTyWU7Ibr/4c7260b6-dd7b-43e7-bbdd-f27f33ed0faa.png) @@ -172,6 +171,7 @@ s2.render() ## 🤝 Contributing + Contributions, issues and feature requests are welcome. Feel free to check [issues](https://github.com/antvis/S2/issues) page if you want to contribute. diff --git a/README.md b/README.md index 93e7b0c549..5e58635db0 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ - 简体中文 | [English](./README.en.md) + 简体中文 | [English](./README.en-US.md) -

@antv/s2

+

S2

@@ -10,6 +10,9 @@

Version + + + @@ -23,25 +26,21 @@ License: MIT@AntV - - -

-S2是一种多维交叉分析表格领域的解决方案，完全基于数据驱动的方式，弥补了行业中此领域的空缺。通过提供底层能力库，基础组件， -业务场景组件以及自由扩展的能力，让开发者基于自身场景自由选择，既能开箱即用，又能自由发挥。 +S2 是 AntV 在多维交叉分析表格领域的解决方案，完全基于数据驱动的方式。通过提供底层能力库，基础组件，业务场景组件以及自由扩展的能力，让开发者基于自身场景自由选择，既能开箱即用，又能自由发挥。 ## ✨ 特性 -1. 多维交叉分析： 告别单一分析维度，全面拥抱任意维度的自由组合分析。 -2. 高性能：能支持全量百万数据下的不到8s的渲染，也能通过局部下钻来实现秒级渲染。 -3. 高扩展性：支持任意的自定义扩展（包括但不局限于布局，样式，交互，数据hook流等）。 -4. 开箱即用：提供不同分析场景下开箱即用的react表组件及配套分析组件，只需要简单的配置即可轻松实现复杂场景的表渲染。 -5. 高交互：支持丰富的交互形式（单选、圈选、行选、列选、冻结行头、宽高拖拽，自定义交互等） +1. 多维交叉分析：告别单一分析维度，全面拥抱任意维度的自由组合分析。 +2. 高性能：能支持全量百万数据下 `<8s` 渲染，也能通过局部下钻来实现秒级渲染。 +3. 高扩展性：支持任意的自定义扩展（包括但不局限于布局，样式，交互，数据 hook 流等）。 +4. 开箱即用：提供不同分析场景下开箱即用的 React 表组件及配套分析组件，只需要简单的配置即可轻松实现复杂场景的表渲染。 +5. 高交互：支持丰富的交互形式（单选、圈选、行选、列选、冻结行头、宽高拖拽，自定义交互等）。 ## 📦 安装