Skip to content

Commit

Permalink
doc: README
Browse files Browse the repository at this point in the history
  • Loading branch information
yy-wow committed Oct 30, 2024
1 parent 965730b commit 3f7efcd
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
29 changes: 29 additions & 0 deletions packages/renderer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# tiny-engine-renderer

## Introduction

A Vue3 renderer for tiny-engine.

## Usage

```javascript
// xxx.vue
import { h } from 'vue'
import Main, { api } from '@open/tiny-engine-renderer'

export default {
render() {
// utils
api.setUtils(utils)
// globalState
api.setGlobalState(globalState)
// dataSource
api.setDataSourceMap(dataSourceList)
// schema
api.setSchema(schema)

return h(Main)
}
}
```

28 changes: 28 additions & 0 deletions packages/renderer/README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# tiny-engine-renderer

## 简介

基于 Vue 3 的低代码渲染引擎。

## 用法

```javascript
// xxx.vue
import { h } from 'vue'
import Main, { api } from '@open/tiny-engine-renderer'

export default {
render() {
// 工具类
api.setUtils(utils)
// 全局状态
api.setGlobalState(globalState)
// 数据源
api.setDataSourceMap(dataSourceList)
// 页面schema
api.setSchema(schema)

return h(Main)
}
}
```

0 comments on commit 3f7efcd

Please sign in to comment.