From 7dfd0333b1bb7d023ada6600dcc935f1c43b2c25 Mon Sep 17 00:00:00 2001 From: Max Date: Mon, 29 Aug 2022 20:00:33 +0800 Subject: [PATCH] [change] Introduction --- README.md | 10 ++++++++++ README.zh-CN.md | 12 ++++++++++-- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 62f66c9e..848a534e 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,16 @@ [中文介绍](README.zh-CN.md) +YAO is an open-source application engine, written in Golang, in the form of a command-line tool that can be downloaded and used immediately. It is suitable for developing business systems, website/APP API, admin panel, self-built low-code platforms, etc. + +YAO adopts a flow-based programming model to implement various functions by writing YAO DSL (Logical Description in JSON format) or using JavaScript to write processes. The YAO DSL can be written in several ways: + +1. Purely hand-written + +2. Use automated scripts to generate contextual logic + +3. Use the visual editor to create by "drag and drop" + **Discord:** https://discord.gg/nsKmCXwvxU **Documentation:** https://yaoapps.com/en-US/doc diff --git a/README.zh-CN.md b/README.zh-CN.md index 41d719b2..ef5828a6 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -3,11 +3,19 @@ [![UnitTest](https://github.com/YaoApp/yao/actions/workflows/unit-test.yml/badge.svg)](https://github.com/YaoApp/yao/actions/workflows/unit-test.yml) [![codecov](https://codecov.io/gh/YaoApp/yao/branch/main/graph/badge.svg?token=294Y05U71J)](https://codecov.io/gh/YaoApp/yao) -![intro](docs/1.intro.png) +![intro](docs/architecture.png) + +[English](README.md) YAO 是一款开源应用引擎,使用 Golang 编写,以一个命令行工具的形式存在, 下载即用。适合用于开发业务系统、网站/APP API 接口、管理后台、自建低代码平台等。 -[English](README.md) +YAO 采用 flow-based 的编程模式,通过编写 YAO DSL (JSON 格式逻辑描述) 或使用 JavaScript 编写处理器,实现各种功能。 YAO DSL 可以有多种编写方式: + +1. 纯手工编写 + +2. 使用自动化脚本,根据上下文逻辑生成 + +3. 使用可视化编辑器,通过“拖拉拽”制作 官网: [https://yaoapps.com](https://yaoapps.com)