Skip to content

Commit

Permalink
👏Add Packagist
Browse files Browse the repository at this point in the history
  • Loading branch information
liluoao authored Feb 11, 2018
1 parent 2d95e36 commit 745f235
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 通过定义PHP Doc规则生成API文档

[![GitHub forks](https://img.shields.io/github/forks/mumbaicat/makeapidoc.svg?style=plastic)](https://github.com/liluoao/api-doc/network/members)
[![GitHub stars](https://img.shields.io/github/stars/liluoao/api-doc.svg?style=for-the-badge)](https://github.com/liluoao/api-doc/stargazers) [![GitHub forks](https://img.shields.io/github/forks/liluoao/api-doc.svg?style=for-the-badge)](https://github.com/liluoao/api-doc/network) [![Packagist](https://img.shields.io/packagist/v/liluoao/api-doc.svg?style=for-the-badge)](https://packagist.org/packages/liluoao/api-doc) [![GitHub license](https://img.shields.io/github/license/liluoao/api-doc.svg?style=for-the-badge)](https://github.com/liluoao/api-doc/blob/master/LICENSE)
----

### 规则:
Expand All @@ -15,11 +15,15 @@
### 使用方法:

1. 引入核心库
1. 引入本库
```
composer require liluoao/api-doc
```
或直接下载源码
```php
require 'src/ApiDoc.php';
//or
use your-namespace\ApiDoc;
//or
require 'src/ApiDoc.php';
```

2. 实例化核心类
Expand Down Expand Up @@ -61,4 +65,4 @@ public function hello(string $name, string $say): string {
#### 结果:
![example](https://raw.githubusercontent.com/liluoao/api-doc/master/test/example.png)

>注:生成后引入LayUI的路径需根据你生成路径修改
>注:生成后引入LayUI的路径需根据你生成路径修改

0 comments on commit 745f235

Please sign in to comment.