Merge pull request #141 from SkyAPM/develop

Update Docs

docs/install-agent.md

@@ -13,12 +13,12 @@ git clone https://github.com/SkyAPM/SkyAPM-php-sdk.git
 cd SkyAPM-php-sdk
 phpize && ./configure && make && make install
 
-// download sky_php_agent
-// e.g. 3.0.0
-wget https://github.com/SkyAPM/SkyAPM-php-sdk/releases/download/3.0.0/sky_php_agent_linux_x64
-mv sky_php_agent_linux_x64 sky_php_agent
-chmod +x sky_php_agent
-cp sky_php_agent /usr/bin
+// download sky-php-agent
+// e.g. 3.2.0
+wget https://github.com/SkyAPM/SkyAPM-php-sdk/releases/download/3.2.0/sky-php-agent-linux-x64
+mv sky-php-agent-linux-x64 sky-php-agent
+chmod +x sky-php-agent
+cp sky-php-agent /usr/bin
 ```
 
 # How to use
@@ -33,15 +33,21 @@ extension=skywalking.so
 skywalking.enable = 1
 
 ; Set skyWalking collector version (5 or 6)
-skywalking.version = 5
+skywalking.version = 6
 
 ; Set app code e.g. MyProjectName
 skywalking.app_code = MyProjectName
 ```
 
-Run `sky_php_agent` to send PHP generated log information to `SkyWalking collector`
+Run `sky-php-agent` to send PHP generated log information to `SkyWalking collector`
 ```shell
-// sky_php_agent [collector grpc address]
+// sky-php-agent [collector grpc address]
 // e.g.
-sky_php_agent 127.0.0.1:11800
+sky-php-agent --grpc 127.0.0.1:11800
+```
+
+Show help
+
+```bash
+sky-php-agent -h
 ```
\ No newline at end of file

docs/quick-start.md

-# todo
+# todo
\ No newline at end of file
+
+See [Install php agent](install-agent.md)
\ No newline at end of file

docs/zh/change-log.md

+# 20191001
+## Agent 修改
+1. 修改文件权限为0777
+1. 执行`sky-php-agent -h` 查看可用参数
+
 # 20190722
 ## SkyWalking 扩展修改
 1. 支持对mysqli扩展的支持(目前暂时仅支持`mysqli::query()`)
@@ -5,7 +10,7 @@
 # 20190719
 ## Agent 修改
 1. agent创建的文件权限修改为0666, 文件的类型修改为sock类型。修复php与sock文件进行通信时提示"Permission Deny"的问题  
-2. agent的参数接收方式修改, 执行`sky_php_agent -h` 查看可用参数
+2. agent的参数接收方式修改, 执行`sky-php-agent -h` 查看可用参数
 3. agent支持在参数中指定sock文件的路径
 
 ## SkyWalking 扩展修改

docs/zh/start-agent.md

@@ -6,12 +6,12 @@
     x64/x86分别指64位操作系统/32位操作系统
 
 ```
-sky_php_agent_darwin_x64
-sky_php_agent_darwin_x86
-sky_php_agent_linux_x64
-sky_php_agent_linux_x86
-sky_php_agent_linux_arm64
-sky_php_agent_linux_arm86
+sky-php-agent-darwin-x64
+sky-php-agent-darwin-x86
+sky-php-agent-linux-x64
+sky-php-agent-linux-x86
+sky-php-agent-linux-arm64
+sky-php-agent-linux-arm86
 ```
 
 
@@ -19,10 +19,10 @@ sky_php_agent_linux_arm86
 
 ```shell
 # 添加可执行权限
-sudo chmod +x ./sky_php_agent_linux_x64
+sudo chmod +x ./sky-php-agent-linux-x64
 
 # 启动
-./sky_php_agent_linux_x64 127.0.0.1:11800 /tmp/sky_agent.sock
+./sky-php-agent-linux-x64 127.0.0.1:11800 /tmp/sky_agent.sock
 ```