From c423362886c5247a4efac8e9c83ba5310cf027e5 Mon Sep 17 00:00:00 2001 From: sy-records <52o@qq52o.cn> Date: Sat, 11 Apr 2020 09:11:33 +0800 Subject: [PATCH] update readme --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 16c8b49f..f42a6947 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Qiniu Cloud SDK for PHP -[![doxygen.io](http://doxygen.io/github.com/qiniu/php-sdk/?status.svg)](http://doxygen.io/github.com/qiniu/php-sdk/) + [![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE) [![Build Status](https://travis-ci.org/qiniu/php-sdk.svg)](https://travis-ci.org/qiniu/php-sdk) [![Latest Stable Version](https://img.shields.io/packagist/v/qiniu/php-sdk.svg)](https://packagist.org/packages/qiniu/php-sdk) @@ -11,18 +11,20 @@ ## 安装 -* 通过composer，这是推荐的方式，可以使用composer.json 声明依赖，或者运行下面的命令。SDK 包已经放到这里 [`qiniu/php-sdk`][install-packagist] 。 +* 推荐使用 composer 进行安装。可以使用 composer.json 声明依赖，或者运行下面的命令。SDK 包已经放到这里 [`qiniu/php-sdk`][install-packagist] 。 + ```bash $ composer require qiniu/php-sdk ``` -* 直接下载安装，SDK 没有依赖其他第三方库，但需要参照 composer的autoloader，增加一个自己的autoloader程序。 + +* 直接下载安装，SDK 没有依赖其他第三方库，但需要参照 composer 的 autoloader，增加一个自己的 autoloader 程序。 ## 运行环境 -| Qiniu SDK版本 | PHP 版本 | -|:--------------------:|:---------------------------:| -| 7.x | cURL extension, 5.3 - 5.6,7.0 | -| 6.x | cURL extension, 5.2 - 5.6 | +| Qiniu SDK 版本 | PHP 版本 | +| :------------: | :---------------------------: | +| 7.x | cURL extension, 5.3 - 5.6,7.0 | +| 6.x | cURL extension, 5.2 - 5.6 | ## 使用方法 @@ -46,7 +48,7 @@ $ ./vendor/bin/phpunit tests/Qiniu/Tests/ ## 常见问题 -- $error保留了请求响应的信息，失败情况下ret 为none, 将$error可以打印出来，提交给我们。 +- `$error` 保留了请求响应的信息，失败情况下 `$ret` 为 `none`, 将 `$error` 可以打印出来，提交给我们。 - API 的使用 demo 可以参考 [单元测试](https://github.com/qiniu/php-sdk/blob/master/tests)。 ## 代码贡献 @@ -62,14 +64,14 @@ $ ./vendor/bin/phpunit tests/Qiniu/Tests/ - 如果需要帮助，请提交工单（在portal右侧点击咨询和建议提交工单，或者直接向 support@qiniu.com 发送邮件） - 如果有什么问题，可以到问答社区提问，[问答社区](http://qiniu.segmentfault.com/) - 更详细的文档，见[官方文档站](http://developer.qiniu.com/) -- 如果发现了bug， 欢迎提交 [issue](https://github.com/qiniu/php-sdk/issues) +- 如果发现了 bug， 欢迎提交 [issue](https://github.com/qiniu/php-sdk/issues) - 如果有功能需求，欢迎提交 [issue](https://github.com/qiniu/php-sdk/issues) - 如果要提交代码，欢迎提交 pull request - 欢迎关注我们的[微信](http://www.qiniu.com/#weixin) [微博](http://weibo.com/qiniutek)，及时获取动态信息。 ## 代码许可 -The MIT License (MIT).详情见 [License文件](https://github.com/qiniu/php-sdk/blob/master/LICENSE). +The MIT License (MIT). 详情见 [License文件](https://github.com/qiniu/php-sdk/blob/master/LICENSE). [packagist]: http://packagist.org [install-packagist]: https://packagist.org/packages/qiniu/php-sdk