docs(datawizard): readme (antvis#16)

README.md

@@ -57,17 +57,23 @@ At the same time, this package also facilitates us to develop products of chart
 @antv/knowledge
 ```
 
-### 📦 AVA/DataWizard
+### 📦 [AVA/DataWizard](./packages/datawizard/README.md)
 
 DataWizard is a js/ts library for data processing. In the AVA framework, it is used to 'understand' the input dataset. However, it can also be used independently to develop some statistical or data mocking functions.
 
+```js
+@antv/dw-analyzer // to understand a dataset
+@antv/dw-random // to generate random mock data
+```
+
 ### 📦 AVA/ChartAdvisor
 
 ChartAdvisor is the core component of AVA. It recommends charts based on dataset and analysis needs.
 
 ## Resources
 
-- [API Reference](API.md)
+- [API Reference](docs/api/index.md)
+- [`autoChart` API](API.md)
 - [Examples](EXAMPLES.md)
 - [Wiki](https://github.com/antvis/AVA/wiki)
 

packages/datawizard/README.md

@@ -0,0 +1,96 @@
+<img src="https://gw.alipayobjects.com/zos/antfincdn/R8sN%24GNdh6/language.svg" width="18"> English | [简体中文](./zh-CN/README.zh-CN.md)
+
+<h1 align="center">
+  <p>DataWizard</p>
+  <span style="font-size: 24px;">AVA/DataWizard</span>
+</h1>
+
+<div align="center">
+
+A JavaScript library for data processing and dataset analysis.
+
+</div>
+
+DataWizard is a js/ts library for data processing. In the AVA framework, it is used to 'understand' the input dataset. However, it can also be used independently to develop some statistical or data mocking functions.
+
+## Features
+
+### Dataset Analysis
+
+DataWizard can help you extract information of fields from a dataset sample by its `dw-analyzer` module. The information includes the field's **characteristics** (field name, data type, statistics, etc.) and **properties** (continuity, discreteness, etc.), as well as **field-to-field relationships** (correlation, periodicity, etc.).
+
+In short, DataWizard can help you understand a dataset. This is the premise of data analysis and Automatic chart recommendation.
+
+### Data Mocking
+
+The `dw-random` module of DataWizard provides you comprehensive data mocking options. You can use it to quickly develop some data generating or auto-filling functions. For example, the auto-fill function in the desgin engineering plugin <img src="https://gw.alipayobjects.com/zos/rmsportal/LFooOLwmxGLsltmUjTAP.svg" width="18"> [Kitchen](https://kitchen.alipay.com/) 
+
+<div align="center">
+<img src="https://gw.alipayobjects.com/zos/antfincdn/r4gEasYXD%24/kitchendatamocken.png" width="600" />
+</div>
+
+## Installation
+
+```bash
+$ npm install @antv/dw-analyzer
+$ npm install @antv/dw-random
+```
+
+## Usage
+
+### dw-analyzer
+
+```js
+import { type }  from '@antv/dw-analyzer';
+
+const a = [1, 2, 3];
+
+const info = type(a);
+
+// the info of the dataset:
+// {
+//   "count": 3,
+//   "distinct": 3,
+//   "type": "integer",
+//   "recommendation": "integer",
+//   "missing": 0,
+//   "samples": [1, 2, 3],
+//   "valueMap": {"1": 1, "2": 1, "3": 1},
+//   "minimum": 1,
+//   "maximum": 3,
+//   "mean": 2,
+//   "percentile5": 1,
+//   "percentile25": 1,
+//   "percentile50": 2,
+//   "percentile75": 3,
+//   "percentile95": 3,
+//   "sum": 6,
+//   "variance": 0.6666666666666666,
+//   "stdev": 0.816496580927726,
+//   "zeros": 0
+// }
+```
+
+### dw-random
+
+```js
+import random from '@antv/dw-random';
+
+const name = random.name();
+
+// some random name such as:
+// Julian Brady, Louise Gonzales, Polly Maxwell...
+```
+
+## Documentation
+
+* dw-anayzer
+  * [Quick Start](./analyzer/README.md)
+  * [API Reference](../../docs/api/dw-analyzer.md)
+* dw-random
+  * Quick Start
+  * [API Reference](../../docs/api/dw-random.md)
+
+## License
+
+MIT

packages/datawizard/zh-CN/README.zh-CN.md

@@ -0,0 +1,98 @@
+<img src="https://gw.alipayobjects.com/zos/antfincdn/R8sN%24GNdh6/language.svg" width="18"> [English](../README.md) | 简体中文
+
+<h1 align="center">
+  <p>DataWizard</p>
+  <span style="font-size: 24px;">AVA/DataWizard</span>
+</h1>
+
+<div align="center">
+
+前端数据处理和数据集分析类库
+
+</div>
+
+DataWizard 是一个 js/ts 的前端数据处理类库。在 AVA 的框架中，它被用来“理解”输入端的数据集。不过，它也可以独立地被用来开发一些数学统计、数据模拟之类的功能。
+
+
+## 特性
+
+### 数据集分析
+
+DataWizard 的 `dw-analyzer` 模块可以从一个数据集样本中提取出各个字段的信息。这些信息包括字段的**特征**（字段名称、数据类型、统计信息，等）和**性质**（连续性、离散性，等），以及多字段间的**字段间关系**（相关性、周期性，等）。
+
+简而言之，DataWizard 可以帮助你了解一个数据集。这也是我们做数据分析、智能可视化等工作的前提。
+
+### 数据模拟
+
+DataWizard 的 `dw-random` 模块提供了非常丰富的模拟数据生成能力。你可以用它来快速开发一些数据模拟或自动填充类的功能。比如蚂蚁金服的设计工程化插件 <img src="https://gw.alipayobjects.com/zos/rmsportal/LFooOLwmxGLsltmUjTAP.svg" width="18"> [Kitchen](https://kitchen.alipay.com/) 中的自动填充功能。
+
+<div align="center">
+<img src="https://gw.alipayobjects.com/zos/antfincdn/6gRaznRUDU/kitchendatamockcn.png" width="600" />
+</div>
+
+## 安装
+
+```bash
+$ npm install @antv/dw-analyzer
+$ npm install @antv/dw-random
+```
+
+## 用法
+
+### dw-analyzer
+
+```js
+import { type }  from '@antv/dw-analyzer';
+
+const a = [1, 2, 3];
+
+const info = type(a);
+
+// 数据集的信息：
+// {
+//   "count": 3,
+//   "distinct": 3,
+//   "type": "integer",
+//   "recommendation": "integer",
+//   "missing": 0,
+//   "samples": [1, 2, 3],
+//   "valueMap": {"1": 1, "2": 1, "3": 1},
+//   "minimum": 1,
+//   "maximum": 3,
+//   "mean": 2,
+//   "percentile5": 1,
+//   "percentile25": 1,
+//   "percentile50": 2,
+//   "percentile75": 3,
+//   "percentile95": 3,
+//   "sum": 6,
+//   "variance": 0.6666666666666666,
+//   "stdev": 0.816496580927726,
+//   "zeros": 0
+// }
+```
+
+### dw-random
+
+```js
+import random from '@antv/dw-random';
+
+const name = random.name();
+
+// 随机生成的名称，比如：
+// Julian Brady, Louise Gonzales, Polly Maxwell...
+```
+
+## 文档
+
+* dw-anayzer
+  * [快速上手](../analyzer/README.zh-CN.md)
+  * [API 接口文档](../../../docs/api/dw-analyzer.md)
+* dw-random
+  * 快速上手
+  * [API 接口文档](../../../docs/api/dw-random.md)
+
+
+## 证书
+
+MIT

packages/knowledge/README.md

@@ -11,7 +11,6 @@ A knowledge base stores the wiki for every type of visualization.
 
 [![Version](https://badgen.net/npm/v/@antv/knowledge)](https://www.npmjs.com/@antv/knowledge)
 [![NPM downloads](http://img.shields.io/npm/dm/@antv/knowledge.svg)](http://npmjs.com/@antv/knowledge)
-![Latest commit](https://badgen.net/github/last-commit/antvis/knowledge)
 
 </div>
 

packages/knowledge/zh-CN/README.zh-CN.md

@@ -11,7 +11,6 @@
 
 [![Version](https://badgen.net/npm/v/@antv/knowledge)](https://www.npmjs.com/@antv/knowledge)
 [![NPM downloads](http://img.shields.io/npm/dm/@antv/knowledge.svg)](http://npmjs.com/@antv/knowledge)
-![Latest commit](https://badgen.net/github/last-commit/antvis/knowledge)
 
 </div>
 

zh-CN/README.zh-CN.md

@@ -46,7 +46,7 @@ autoChart(container, data, {toolbar: true, development: true});
 
 ## 包
 
-### 📦 [AVA/CKB](./packages/knowledge/README.md)
+### 📦 [AVA/CKB](../packages/knowledge/zh-CN/README.zh-CN.md)
 
 CKB 的意思是 Chart Knowledge Base，也就是图表知识库。这个包中包含了基于经验总结的关于可视化和图表的各种基本知识和观察。图表的推荐必须基于这些基本概念。
 
@@ -56,19 +56,23 @@ CKB 的意思是 Chart Knowledge Base，也就是图表知识库。这个包中
 @antv/knowledge
 ```
 
-### 📦 AVA/DataWizard
+### 📦 [AVA/DataWizard](../packages/datawizard/zh-CN/README.zh-CN.md)
 
 DataWizard 是一个 js/ts 的前端数据处理类库。在 AVA 的框架中，它被用来“理解”输入端的数据集。不过，它也可以独立地被用来开发一些数学统计、数据模拟之类的功能。
 
-### 📦 AVA/ChartAdvisor
+```js
+@antv/dw-analyzer // to understand a dataset
+@antv/dw-random // to generate random mock data
+```
 
-ChartAdvisor is the core component of AVA. It recommends charts based on dataset and analysis needs.
+### 📦 AVA/ChartAdvisor
 
 ChartAdvisor 是 AVA 的核心部分。它基于数据和分析需求来推荐图表类型和具体的图表细节设置。
 
 ## 资源
 
-- [API 接口文档](API.zh-CN.md)
+- [API 接口文档](../docs/api/index.md)
+- [`autoChart` 临时接口文档](API.zh-CN.md)
 - [教程示例](EXAMPLES.zh-CN.md)
 - [Wiki 百科](https://github.com/antvis/AVA/wiki)