# gitee-intro

[![npm](https://img.shields.io/npm/v/gitee-intro.svg)](https://gitee.com/gitee-frontend/gitee-intro/releases)
[![gitee-release-cli](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-gitee--release-blueviolet.svg)](https://gitee.com/gitee-frontend/gitee-reelase-cli/blob/master/LICENSE)

## 介绍

一个用于创建功能引导界面的 JS 库。

## 安装

```bash
npm install --save gitee-intro
```

## 使用

```js
import GiteeIntro from 'gitee-intro'

// 创建功能引导实例
const intro = new GiteeIntro({
    name: 'example',
    steps: [{
        type: 'Modal',
        title: '标题',
        content: {
            summary: '一段简单的介绍',
            features: [
                '特点1',
                '特点2',
            ],
            img: '图片地址'
        }
    }]
 })

// 开始引导
intro.start()
```

上述代码中用到了 Modal 控制器展示引导信息，你可以在 `src/controllers` 目录中找到其它控制器，配置参数可参考其源代码中的 `defaults` 对象内容。

## 发布

``` bash
# 创建 beta 预发行版
npm run release-beta

# 发布测试版
npm publish --tag=beta

# 创建正式发行版
npm run release

# 发布正式版
npm publish
```