docs(README): perfect readme

2026-07-19 18:23:32 -04:00 · 2019-03-01 22:37:30 +08:00
parent 8f9f5ae16d
commit 7cb2fc5846
2 changed files with 51 additions and 11 deletions
@@ -4,10 +4,30 @@

 [中文版](README_CN.md)

-ncform, a pleasing form development method that generates form UIs and their interactions with just configuration.
-
 ![preview](docs/images/preview.png)

+ncform, a nice form development way that generates form UIs and their interactions with just configuration.
+
+Comes with **standard components** and **validation rules**, out of the box.
+
+Have powerful **control interaction** and **extension capabilities**, do what you want.
+
+---
+
+- Table Of Contents
+  - [Playground](#Playground)
+  - [Quick Start](#Quick-Start)
+    - [In node.js](#In-node.js)
+    - [In browser](#In-browser)
+  - [Features](#Features)
+  - [Documents](#Documents)
+  - [Solve Pain Points](#Solve-Pain-Points)
+  - [Repeat the wheel?](#Repeat-the-wheel?)
+  - [Why not use the standard json-schema?](#Why-not-use-the-standard-json-schema?)
+  - [dx expression](#dx-expression)
+  - [Design Thinking](#Design-Thinking)
+  - [Schema Generator](#Schema-Generator)
+
 ## Playground

 Experience the charm of ncform on the [Playground](https://ncform.github.io/ncform/ncform-show/playground/index.html) to deepen your understanding of ncform
@@ -78,7 +98,7 @@ export default {
 ```
 You can refer to the [ncform-demo](https://github.com/daniel-dx/ncform-demo) project

-### In a browser
+### In browser

 ```
 <html>
@@ -148,11 +168,11 @@ You can refer to the [ncform-demo](https://github.com/daniel-dx/ncform-demo) pro

 ## Documents

- [ncform config/props/api/event](./CONFIG.md)
+- [ncform config / props / api / event](./CONFIG.md)

- [Standard Components](./STD-COMP.md)
+- Standard Components [Preview Version](https://ncform.github.io/ncform/ncform-theme-elementui/index.html) | [Text Version](./STD-COMP.md)

- [How to extend](./EXT-DOC.md)
+- [Custom Form Controls And Validation Rules](./EXT-DOC.md)

 ## Solve Pain Points

@@ -4,9 +4,29 @@

 [English Version](README.md)

+![preview](docs/images/preview.png)
+
 ncform，一种令人愉悦的表单开发方式，仅需配置即可生成表单UI及其交互行为。

-![preview](docs/images/preview.png)
+自带丰富的 **标准组件** 和 **校验规则**，开箱即用。
+
+具备强大的 **控件交互** 和 **扩展能力**，做你所想。
+
+---
+
+- 目录
+  - [Playground](#Playground)
+  - [Quick Start](#Quick-Start)
+    - [In node.js](#In-node.js)
+    - [In browser](#In-browser)
+  - [特性](#特性)
+  - [文档](#文档)
+  - [解决痛点](#解决痛点)
+  - [重复造轮子？](#重复造轮子？)
+  - [为什么不用标准的json-schema？](#为什么不用标准的json-schema？)
+  - [dx表达式](#dx表达式)
+  - [设计思想](#设计思想)
+  - [Schema Generator](#Schema-Generator)

 ## Playground

@@ -78,7 +98,7 @@ export default {
 ```
 可参考[ncform-demo](https://github.com/daniel-dx/ncform-demo)项目

-### In a browser
+### In browser

 ```
 <html>
@@ -148,11 +168,11 @@ export default {

 ## 文档

- [ncform config/props/api/event](./CONFIG.md)
+- [ncform config / props / api / event](./CONFIG.md)

- [Standard Components](./STD-COMP_CN.md)
+- [标准组件预览版本](https://ncform.github.io/ncform/ncform-theme-elementui/index.html) / [标准组件文字版](./STD-COMP_CN.md)

- [How to extend](./EXT-DOC.md)
+- [如何扩展 表单控件 / 校验规则](./EXT-DOC.md)

 ## 解决痛点