Skip to content

Commit 4feb5f8

Browse files
authored
Update README.md
1 parent c144c4d commit 4feb5f8

File tree

1 file changed

+53
-41
lines changed

1 file changed

+53
-41
lines changed

README.md

Lines changed: 53 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -6,84 +6,95 @@
66

77
## 环境准备
88
* PHP 5.3+
9-
您可以通过`php -v`命令查看当前的PHP版本。
10-
9+
您可以通过`php -v`命令查看当前的 PHP 版本。
1110
* cURL 扩展
12-
您可以通过`php -m`命令查看cURL扩展是否已经安装好
11+
您可以通过`php -m`命令查看 cURL 扩展是否已经安装好
1312

14-
> **说明:**
15-
>
16-
> * Ubuntu系统中,您可以使用apt-get包管理器安装PHP的cURL扩展 `sudo apt-get install php-curl`
17-
> * CentOS系统中,您可以使用yum包管理器安装PHP的cURL扩展 `sudo yum install php-curl`
13+
>- Ubuntu 系统中,您可以使用 apt-get 包管理器安装 PHP 的 cURL 扩展,安装命令如下。
14+
```
15+
sudo apt-get install php-curl
16+
```
17+
>- CentOS 系统中,您可以使用 yum 包管理器安装 PHP 的 cURL 扩展。
18+
```
19+
sudo yum install php-curl
20+
```
1821

19-
### SDK 安装
20-
有三种方式安装SDK
21-
* Composer方式
22-
* Phar方式
22+
## SDK 安装
23+
SDK 安装有三种方式
24+
* Composer 方式
25+
* Phar 方式
2326
* 源码方式
24-
#### 1、Composer方式
25-
推荐用户使用 Composer 安装 cos-php-sdk-v5,Composer是PHP的依赖管理工具,允许您声明项目所需的依赖,然后自动将它们安装到您的项目中。
2627

27-
> **提示**:您可以在 [getcomposer.org](getcomposer.org) 上找到更多关于如何安装Composer,配置自动加载以及用于定义依赖项的其他最佳实践。
28+
### Composer 方式
29+
推荐使用 Composer 安装 cos-php-sdk-v5,Composer 是 PHP 的依赖管理工具,允许您声明项目所需的依赖,然后自动将它们安装到您的项目中。
30+
> 您可以在 [Composer 官网](https://getcomposer.org/) 上找到更多关于如何安装 Composer,配置自动加载以及用于定义依赖项的其他最佳实践等相关信息。
2831
29-
**使用 Composer 安装 COS-PHP-SDK-V5**
30-
1. 打开终端
31-
2. 下载 Composer
32+
#### 安装步骤:
33+
1. 打开终端
34+
2. 下载 Composer,执行以下命令。
3235
```
3336
curl -sS https://getcomposer.org/installer | php
3437
```
35-
3. 创建一个名为`composer.json`的文件,内容为
38+
3. 创建一个名为`composer.json`的文件,内容如下。
3639
```
3740
{
3841
"require": {
39-
"qcloud/cos-sdk-v5": ">=1.3"
42+
"qcloud/cos-sdk-v5": "1.*"
4043
}
4144
}
4245
```
43-
4. 使用 Composer 安装
46+
4. 使用 Composer 安装,执行以下命令。
4447
```
4548
php composer.phar install
4649
```
47-
使用该命令后会在当前目录中创建一个vendor文件夹,里面包含 sdk 的依赖库和一个 autoload.php 脚本,方便用户在自己的项目中调用
48-
5. 通过 autoloader 脚本调用cos-php-sdk-v5
50+
使用该命令后会在当前目录中创建一个 vendor 文件夹,里面包含 SDK 的依赖库和一个 autoload.php 脚本,方便在项目中调用
51+
5. 通过 autoloader 脚本调用 cos-php-sdk-v5
4952
```
5053
require '/path/to/sdk/vendor/autoload.php';
5154
```
52-
现在您的项目已经可以使用COS的V5 SDK了。
5355

56+
现在您的项目已经可以使用 COS 的 V5 版本 SDK 了。
5457

55-
#### 2、Phar方式
56-
phar方式安装SDK的步骤如下:
57-
58-
1.[github发布页面](https://github.com/tencentyun/cos-php-sdk-v5/releases)下载相应的phar文件
59-
60-
2. 在代码中引入phar文件:
58+
### Phar 方式
59+
Phar 方式安装 SDK 的步骤如下:
60+
1.[GitHub 发布页面](https://github.com/tencentyun/cos-php-sdk-v5/releases) 下载相应的 phar 文件。
61+
2. 在代码中引入 phar 文件:
6162
```
6263
require '/path/to/cos-sdk-v5.phar';
6364
```
6465

65-
#### 3、源码方式
66-
源码方式安装SDK的步骤如下:
67-
68-
1.[github发布页面](https://github.com/tencentyun/cos-php-sdk-v5/releases)下载相应的zip文件
69-
70-
2. 解压通过 autoload.php 脚本加载sdk
66+
### 源码方式
67+
源码方式安装 SDK 的步骤如下:
68+
1.[GitHub 发布页面](https://github.com/tencentyun/cos-php-sdk-v5/releases) 下载相应的 zip 文件。
69+
2. 解压通过 autoload.php 脚本加载 SDK:
7170
```
7271
require '/path/to/sdk/vendor/autoload.php';
7372
```
7473

75-
7674
## 快速入门
77-
可参照Demo程序,详见 [sample.php](https://github.com/tencentyun/cos-php-sdk-v5/blob/master/sample.php)
75+
可参照 Demo 程序,详见 [sample.php](https://github.com/tencentyun/cos-php-sdk-v5/blob/master/sample.php)
76+
7877
## 接口文档
7978
php sdk 接口文档,详见https://cloud.tencent.com/document/product/436/12267
79+
8080
### 配置文件
8181
```php
82-
$cosClient = new Qcloud\Cos\Client(array('region' => 'COS_REGION',
82+
$cosClient = new Qcloud\Cos\Client(array('region' => '<Region>',
83+
'credentials'=> array(
84+
'secretId' => '<SecretId>',
85+
'secretKey' => '<SecretKey>')));
86+
```
87+
88+
若您使用 [临时密钥](https://cloud.tencent.com/document/product/436/14048) 初始化,请用下面方式创建实例。
89+
90+
```
91+
$cosClient = new Qcloud\Cos\Client(array('region' => getenv('COS_REGION'),
8392
'credentials'=> array(
84-
'secretId' => 'COS_KEY',
85-
'secretKey' => 'COS_SECRET')));
86-
```
93+
'secretId' => '<SecretId>',
94+
'secretKey' => '<SecretKey>',
95+
'token' => '<XCosSecurityToken>')));
96+
```
97+
8798
### 上传文件
8899
* 使用putObject接口上传文件(最大5G)
89100
* 使用Upload接口分块上传文件
@@ -255,3 +266,4 @@ try {
255266
print_r($e);
256267
}
257268
```
269+

0 commit comments

Comments
 (0)