From a098afedd37b7d779501199c8a64c7d958ae072a Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?IT=E5=B0=8F=E5=BC=BAxqitw=2Ecn?= <360237521@qq.com>
Date: Wed, 6 Jun 2018 20:50:54 +0800
Subject: [PATCH] =?UTF-8?q?README=20=E6=96=87=E4=BB=B6=E4=BF=AE=E6=94=B9?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 31 ++++++++++++++++++-------------
 1 file changed, 18 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index ea91dd0..b47550e 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
-# api-doc-php
+# Api-Doc-PHP
 
 ### 开源地址：
 
-[GigHub https://github.com/itxq/api-doc-php](https://github.com/itxq/api-doc-php)
+[【GigHub:】https://github.com/itxq/api-doc-php](https://github.com/itxq/api-doc-php)
 
-[码云 https://gitee.com/itxq/api-doc-php](https://github.com/itxq/api-doc-php)
+[【码云:】https://gitee.com/itxq/api-doc-php](https://github.com/itxq/api-doc-php)
     
     
 
@@ -14,31 +14,36 @@
 
 ### 扩展安装：
 
-+ composer命令 `composer require itxq/wechat-sdk-php`
++ 方法一：composer命令 `composer require itxq/wechat-sdk-php`
+
++ 方法二：直接下载压缩包，然后进入项目中执行 composer命令 `composer update` 来生成自动加载文件
 
 ### 引用扩展：
 
 + 当你的项目不支持composer自动加载时，可以使用以下方式来引用该扩展包
 
-`require_once __DIR__ . '/vendor/autoload.php'`
+```
+// 引入扩展（具体路径请根据你的目录结构自行修改）
+require_once __DIR__ . '/vendor/autoload.php';
+```
 
 ### 使用扩展：
 
 ```
-// 引入SDK
-require_once __DIR__ . '/vendor/autoload.php';
-
-// 配置信息
+// 引入扩展（具体路径请根据你的目录结构自行修改）
+require_once __DIR__ . '/../vendor/autoload.php';
+// 加载测试API类1
+require_once __DIR__ . '/Api.php';
+// 加载测试API类2
+require_once __DIR__ . '/Api2.php'; 
 $config = [
     'class'         => ['Api', 'Api2'], // 要生成文档的类
-    'filter_method' => ['__construct', 'add', 'edit'], // 要过滤的方法名称
+    'filter_method' => ['__construct'], // 要过滤的方法名称
 ];
-
-// 调用
 $api = new \itxq\apidoc\ApiDoc($config);
 $doc = $api->getApiDoc();
 echo '<pre>';
 var_dump($doc);
 echo '</pre>';
 ```
-+ 具体使用可参见test目录
\ No newline at end of file
+### 具体效果可运行test目录下的`index.php`查看
\ No newline at end of file