Skip to content

Commit 8e91a6f

Browse files
authored
Update readme (#143)
* Update README.md
1 parent ef772c8 commit 8e91a6f

File tree

1 file changed

+77
-41
lines changed

1 file changed

+77
-41
lines changed

README.md

Lines changed: 77 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,141 @@
11
# COS-PHP-SDK-V5
2-
腾讯云COS-PHP-SDK-V5([XML API](https://cloud.tencent.com/document/product/436/7751)
2+
3+
腾讯云 COS-PHP-SDK-V5([XML API](https://cloud.tencent.com/document/product/436/7751)
34

45
[![Latest Stable Version](https://poser.pugx.org/qcloud/cos-sdk-v5/v/stable)](https://packagist.org/packages/qcloud/cos-sdk-v5)
56
[![Total Downloads](https://img.shields.io/packagist/dt/qcloud/cos-sdk-v5.svg?style=flat)](https://packagist.org/packages/qcloud/cos-sdk-v5)
67
[![Build Status](https://travis-ci.org/tencentyun/cos-php-sdk-v5.svg?branch=master)](https://travis-ci.org/tencentyun/cos-php-sdk-v5)
78
[![codecov](https://codecov.io/gh/tencentyun/cos-php-sdk-v5/branch/master/graph/badge.svg)](https://codecov.io/gh/tencentyun/cos-php-sdk-v5)
9+
810
## 环境准备
9-
* PHP 5.6+
10-
您可以通过`php -v`命令查看当前的 PHP 版本。
11-
>- 如果您的php版本 `>=5.3``<5.6` , 请使用 [ v1.3 ](https://github.com/tencentyun/cos-php-sdk-v5/tree/1.3) 版本
12-
* cURL 扩展
13-
您可以通过`php -m`命令查看 cURL 扩展是否已经安装好。
1411

15-
>- Ubuntu 系统中,您可以使用 apt-get 包管理器安装 PHP 的 cURL 扩展,安装命令如下。
12+
- PHP 5.6+ 您可以通过`php -v`命令查看当前的 PHP 版本。
13+
14+
> - 如果您的 php 版本 `>=5.3``<5.6` , 请使用 [v1.3](https://github.com/tencentyun/cos-php-sdk-v5/tree/1.3) 版本
15+
16+
- cURL 扩展 您可以通过`php -m`命令查看 cURL 扩展是否已经安装好。
17+
18+
> - Ubuntu 系统中,您可以使用 apt-get 包管理器安装 PHP 的 cURL 扩展,安装命令如下。
19+
1620
```
1721
sudo apt-get install php-curl
1822
```
19-
>- CentOS 系统中,您可以使用 yum 包管理器安装 PHP 的 cURL 扩展。
23+
24+
> - CentOS 系统中,您可以使用 yum 包管理器安装 PHP 的 cURL 扩展。
25+
2026
```
2127
sudo yum install php-curl
2228
```
2329

2430
## SDK 安装
31+
2532
SDK 安装有三种方式:
26-
* Composer 方式
27-
* Phar 方式
28-
* 源码方式
33+
34+
- Composer 方式
35+
- Phar 方式
36+
- 源码方式
2937

3038
### Composer 方式
39+
3140
推荐使用 Composer 安装 cos-php-sdk-v5,Composer 是 PHP 的依赖管理工具,允许您声明项目所需的依赖,然后自动将它们安装到您的项目中。
41+
3242
> 您可以在 [Composer 官网](https://getcomposer.org/) 上找到更多关于如何安装 Composer,配置自动加载以及用于定义依赖项的其他最佳实践等相关信息。
3343
34-
#### 安装步骤:
44+
#### 安装步骤:
45+
3546
1. 打开终端。
3647
2. 下载 Composer,执行以下命令。
48+
3749
```
3850
curl -sS https://getcomposer.org/installer | php
3951
```
52+
4053
3. 创建一个名为`composer.json`的文件,内容如下。
41-
```
54+
55+
```json
4256
{
4357
"require": {
4458
"qcloud/cos-sdk-v5": "2.*"
4559
}
4660
}
4761
```
62+
4863
4. 使用 Composer 安装,执行以下命令。
64+
4965
```
5066
php composer.phar install
5167
```
68+
5269
使用该命令后会在当前目录中创建一个 vendor 文件夹,里面包含 SDK 的依赖库和一个 autoload.php 脚本,方便在项目中调用。
53-
5. 通过 autoloader 脚本调用 cos-php-sdk-v5。
54-
```
55-
require '/path/to/sdk/vendor/autoload.php';
70+
71+
5. 通过 autoload.php 脚本调用 cos-php-sdk-v5。
72+
73+
```php
74+
require '/path/to/vendor/autoload.php';
5675
```
5776

5877
现在您的项目已经可以使用 COS 的 V5 版本 SDK 了。
5978

6079
### Phar 方式
80+
6181
Phar 方式安装 SDK 的步骤如下:
82+
6283
1.[GitHub 发布页面](https://github.com/tencentyun/cos-php-sdk-v5/releases) 下载相应的 phar 文件。
63-
2. 在代码中引入 phar 文件:
64-
```
65-
require '/path/to/cos-sdk-v5.phar';
84+
2. 在代码中引入 phar 文件:
85+
86+
```php
87+
require '/path/to/cos-sdk-v5.phar';
6688
```
6789

6890
### 源码方式
91+
6992
源码方式安装 SDK 的步骤如下:
70-
1.[GitHub 发布页面](https://github.com/tencentyun/cos-php-sdk-v5/releases) 下载相应的 cos-sdk-v5.tar.gz
71-
文件。
72-
2. 解压通过 autoload.php 脚本加载 SDK:
73-
```
74-
require '/path/to/sdk/vendor/autoload.php';
93+
94+
1.[GitHub 发布页面](https://github.com/tencentyun/cos-php-sdk-v5/releases) 下载相应的 cos-sdk-v5.tar.gz 文件。
95+
2. 解压后通过 autoload.php 脚本加载 SDK:
96+
97+
```php
98+
require '/path/to/cos-php-sdk-v5/vendor/autoload.php';
7599
```
76100

77-
## 快速入门
78-
可参照 Demo 程序,详见 [sample目录](https://github.com/tencentyun/cos-php-sdk-v5/tree/master/sample)
101+
## 快速入门
102+
103+
可参照 Demo 程序,详见 [sample 目录](https://github.com/tencentyun/cos-php-sdk-v5/tree/master/sample)
79104

80105
## 接口文档
81-
php sdk 接口文档,详见https://cloud.tencent.com/document/product/436/12267
106+
107+
PHP SDK 接口文档,详见 [https://cloud.tencent.com/document/product/436/12267](https://cloud.tencent.com/document/product/436/12267)
82108

83109
### 配置文件
110+
84111
```php
85-
$cosClient = new Qcloud\Cos\Client(array('region' => '<Region>',
86-
'credentials'=> array(
87-
'secretId' => '<SecretId>',
88-
'secretKey' => '<SecretKey>')));
112+
$cosClient = new Qcloud\Cos\Client(array(
113+
'region' => '<Region>',
114+
'credentials' => array(
115+
'secretId' => '<SecretId>',
116+
'secretKey' => '<SecretKey>'
117+
)
118+
));
89119
```
90120

91121
若您使用 [临时密钥](https://cloud.tencent.com/document/product/436/14048) 初始化,请用下面方式创建实例。
92122

93-
```
94-
$cosClient = new Qcloud\Cos\Client(array('region' => '<Region>',
95-
'credentials'=> array(
96-
'secretId' => '<SecretId>',
123+
```php
124+
$cosClient = new Qcloud\Cos\Client(array(
125+
'region' => '<Region>',
126+
'credentials' => array(
127+
'secretId' => '<SecretId>',
97128
'secretKey' => '<SecretKey>',
98-
'token' => '<XCosSecurityToken>')));
129+
'token' => '<XCosSecurityToken>'
130+
)
131+
));
99132
```
100133

101134
### 上传文件
102-
* 使用putObject接口上传文件(最大5G)
103-
* 使用Upload接口分块上传文件
135+
136+
- 使用 putObject 接口上传文件(最大 5G)
137+
- 使用 Upload 接口分块上传文件
138+
104139
```php
105140
# 上传文件
106141
## putObject(上传接口,最大支持上传5G文件)
@@ -199,8 +234,10 @@ try {
199234
```
200235

201236
### 下载文件
202-
* 使用getObject接口下载文件
203-
* 使用getObjectUrl接口获取文件下载URL
237+
238+
- 使用 getObject 接口下载文件
239+
- 使用 getObjectUrl 接口获取文件下载 URL
240+
204241
```php
205242
# 下载文件
206243
## getObject(下载文件)
@@ -263,4 +300,3 @@ try {
263300
print_r($e);
264301
}
265302
```
266-

0 commit comments

Comments
 (0)