[教程]: ./doc/教程.md
[API接口文档]: ./doc/api/index.md

[Git仓库]: http://soon.xwbuilders.com:9090/library/ceffect/ceffect
[发行地址]: http://soon.xwbuilders.com:9090/library/ceffect/ceffect/releases
[issues]: http://soon.xwbuilders.com:9090/library/ceffect/ceffect/issues




> 目录

- [1. 背景](#1-背景)
- [2. 简介](#2-简介)
- [3. 安装方式](#3-安装方式)
  - [3.1. 方式1：通过 npm 安装](#31-方式1通过-npm-安装)
  - [3.2. 方式3：通过`<script>`标签引入](#32-方式3通过script标签引入)
- [4. 教程](#4-教程)
- [5. API接口文档](#5-api接口文档)



# 1. 背景

# 2. 简介
库的简单介绍

**具有以下特性：**  
- 特性1
- 特性2
- 特性3

**详情请看：**  
- 主页：<http://soon.xwbuilders.com:9090/library/ceffect/ceffect>
- [Git仓库][]
- [码云仓库][]
- [教程][]
- [API接口文档][]


**如果您在使用的过程中遇到了问题，或者有好的建议和想法，您都可以通过以下方式联系我，期待与您的交流：**
- 给该仓库提交 [issues][]
- 给我 Pull requests
- 邮箱：<guobinyong@qq.com>





# 3. 安装方式
目前，安装方式有以下几种：


## 3.1. 方式1：通过 npm 安装
通过 npm （或 yarn、pnpm 等包管理器）安装
```
npm install @soon-gis/effect
```




## 3.2. 方式3：通过`<script>`标签引入
您可直接从项目的 [发行地址][] 中下载以 `effect.iife.js` 作为缀的文件，然后使用如下代码引用 和 使用 effect：


1. 引用 @soon-gis/effect
   ```
   <script src="path/to/package/effect.iife.js"></script>
   ```
   
2. 使用全局的 `Effect`
   ```
   <script>
   // 使用全局的 Effect
   </script>
   ```

# 4. 教程
详情跳转至[教程][]

# 5. API接口文档
详情跳转至[API接口文档][]