Skip to content

Commit

Permalink
docs: update readme (#251)
Browse files Browse the repository at this point in the history
* docs: update readme

* chore: add pr template

* docs: fix typo
  • Loading branch information
hustcc authored Sep 10, 2021
1 parent 31dd6a0 commit a13fbce
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 27 deletions.
13 changes: 13 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### PR includes
<!-- Add completed items in this PR, and change [ ] to [x]. -->

- [ ] fixed issue #0
- [ ] add feat, describe your feature
- [ ] add / modify test cases
- [ ] documents, demos

### Screenshot

| Before | After |
|----|----|
|||
7 changes: 0 additions & 7 deletions LEGAL.md

This file was deleted.

16 changes: 8 additions & 8 deletions README.en.md → README.en-US.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<img src="https://gw.alipayobjects.com/zos/antfincdn/R8sN%24GNdh6/language.svg" width="18"> [简体中文](./README.md)
English

<h1 align="center">@antv/s2</h1>
<h1 align="center">S2</h1>

<div align="center">

Expand All @@ -11,6 +11,9 @@ Data-driven multi-dimensional analysis table.
<a href="https://www.npmjs.com/package/@antv/s2" target="_blank">
<img alt="Version" src="https://img.shields.io/npm/v/@antv/s2.svg">
</a>
<a href="https://github.com/antvis/S2/actions" target="_blank">
<img src="https://github.com/antvis/S2/workflows/CI/badge.svg" />
</a>
<a href="https://codecov.io/gh/@antv/s2" target="_blank">
<img src="https://codecov.io/gh/@antv/s2/branch/master/graph/badge.svg" />
</a>
Expand All @@ -23,22 +26,18 @@ Data-driven multi-dimensional analysis table.
<a href="#" target="_blank" target="_blank">
<img alt="License: MIT@AntV" src="https://img.shields.io/badge/[email protected]" />
</a>
<a href="https://github.com/antvis/S2/actions" target="_blank">
<img src="https://github.com/antvis/S2/workflows/CI/badge.svg" />
</a>
</p>

</div>

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.



<!-- ### 🏠 [Homepage](https://s2.antv.vision) -->

## ✨ 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.).
Expand Down Expand Up @@ -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)

Expand All @@ -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.

Expand Down
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<img src="https://gw.alipayobjects.com/zos/antfincdn/R8sN%24GNdh6/language.svg" width="18"> 简体中文 | [English](./README.en.md)
<img src="https://gw.alipayobjects.com/zos/antfincdn/R8sN%24GNdh6/language.svg" width="18"> 简体中文 | [English](./README.en-US.md)


<h1 align="center">@antv/s2</h1>
<h1 align="center">S2</h1>

<div align="center">

Expand All @@ -10,6 +10,9 @@
<p>
<a href="https://www.npmjs.com/package/@antv/s2" target="_blank">
<img alt="Version" src="https://img.shields.io/npm/v/@antv/s2.svg">
</a>
<a href="https://github.com/antvis/S2/actions" target="_blank">
<img src="https://github.com/antvis/S2/workflows/CI/badge.svg" />
</a>
<a href="https://codecov.io/gh/@antv/s2" target="_blank">
<img src="https://codecov.io/gh/@antv/s2/branch/master/graph/badge.svg" />
Expand All @@ -23,25 +26,21 @@
<a href="#" target="_blank" target="_blank">
<img alt="License: MIT@AntV" src="https://img.shields.io/badge/[email protected]" />
</a>
<a href="https://github.com/antvis/S2/actions" target="_blank">
<img src="https://github.com/antvis/S2/workflows/CI/badge.svg" />
</a>
</p>

</div>

S2是一种多维交叉分析表格领域的解决方案,完全基于数据驱动的方式,弥补了行业中此领域的空缺。通过提供底层能力库,基础组件,
业务场景组件以及自由扩展的能力,让开发者基于自身场景自由选择,既能开箱即用,又能自由发挥。
S2 是 AntV 在多维交叉分析表格领域的解决方案,完全基于数据驱动的方式。通过提供底层能力库,基础组件,业务场景组件以及自由扩展的能力,让开发者基于自身场景自由选择,既能开箱即用,又能自由发挥。


<!-- ### 🏠 [Homepage](https://s2.antv.vision) -->

## ✨ 特性
1. 多维交叉分析: 告别单一分析维度,全面拥抱任意维度的自由组合分析。
2. 高性能:能支持全量百万数据下的不到8s的渲染,也能通过局部下钻来实现秒级渲染。
3. 高扩展性:支持任意的自定义扩展(包括但不局限于布局,样式,交互,数据hook流等)。
4. 开箱即用:提供不同分析场景下开箱即用的react表组件及配套分析组件,只需要简单的配置即可轻松实现复杂场景的表渲染。
5. 高交互:支持丰富的交互形式(单选、圈选、行选、列选、冻结行头、宽高拖拽,自定义交互等)
1. 多维交叉分析:告别单一分析维度,全面拥抱任意维度的自由组合分析。
2. 高性能:能支持全量百万数据下 `<8s` 渲染,也能通过局部下钻来实现秒级渲染。
3. 高扩展性:支持任意的自定义扩展(包括但不局限于布局,样式,交互,数据 hook 流等)。
4. 开箱即用:提供不同分析场景下开箱即用的 React 表组件及配套分析组件,只需要简单的配置即可轻松实现复杂场景的表渲染。
5. 高交互:支持丰富的交互形式(单选、圈选、行选、列选、冻结行头、宽高拖拽,自定义交互等)

## 📦 安装

Expand Down

0 comments on commit a13fbce

Please sign in to comment.