@mastergo/plugin-typings/README.md

MasterGo插件API声明文件

[![Publish to NPM](https://github.com/mastergo-design/plugin-typings/actions/workflows/publish.yaml/badge.svg)](https://github.com/mastergo-design/plugin-typings/actions/workflows/publish.yaml)

**中文** | [English](./README-en.md)

# MasterGo插件API声明文件
本项目为MasterGo插件API的ts声明文件。

## 安装

1. 通过npm安装
    ```sh
    npm i --save-dev @mastergo/plugin-typings
    # 或者使用yarn
    yarn add -D @mastergo/plugin-typings
    ```

2. 配置 `tsconfig.json`
    ```js
    {
        "compilerOptions": {
            "typeRoots": [
                "./node_modules/@types",
                "./node_modules/@mastergo"
            ]
        }
    }
    ```