Procházet zdrojové kódy

modify readme Alibaba CLoud Go SDK to Alibaba CLoud SDK for Go

wenzuochao před 6 roky
rodič
revize
b8b4bd0a16

+ 1 - 1
CONTRIBUTING.md

@@ -1,4 +1,4 @@
-# Contributing to the Alibaba Cloud Go SDK
+# Contributing to the Alibaba Cloud SDK for Go
 
 We work hard to provide a high-quality and useful SDK for Alibaba Cloud, and we greatly value feedback and contributions from our community. Please submit your [issues][issues] or [pull requests][pull-requests] through GitHub.
 

+ 5 - 4
README.md

@@ -5,7 +5,7 @@ English | [简体中文](./README_zh.md)
 <a href=" https://www.alibabacloud.com"><img src="https://aliyunsdk-pages.alicdn.com/icons/AlibabaCloud.svg"></a>
 </p>
 
-<h1 align="center">Alibaba Cloud Go SDK</h1>
+<h1 align="center">Alibaba Cloud SDK for Go</h1>
 
 <p align="center">
 <a href="https://badge.fury.io/gh/aliyun%2Falibaba-cloud-sdk-go"><img src="https://badge.fury.io/gh/aliyun%2Falibaba-cloud-sdk-go.svg" alt="Latest Stable Version"></a>
@@ -19,8 +19,9 @@ English | [简体中文](./README_zh.md)
 </p>
 
 
-Alibaba Cloud Go SDK is a client tool that helps Go developers manage credentials and send requests, [Alibaba Cloud Go SDK][SDK] dependency on this tool.
-
+Alibaba Cloud SDK for Go allows you to access Alibaba Cloud services such as Elastic Compute Service (ECS), Server Load Balancer (SLB), and CloudMonitor. You can access Alibaba Cloud services without the need to handle API related tasks, such as signing and constructing your requests.
+                         
+This document introduces how to obtain and call [Alibaba Cloud SDK for Go][SDK].
 
 ## Online Demo
 [API Explorer][open-api] provides the ability to call the cloud product OpenAPI online, and dynamically generate SDK Example code and quick retrieval interface, which can significantly reduce the difficulty of using the cloud API.
@@ -36,7 +37,7 @@ Use `go get` to install SDK:
 $ go get -u github.com/aliyun/alibaba-cloud-sdk-go/sdk
 ```
 
-If you have used glide to manage dependence,you can also use glide to install Alibaba Cloud Go SDK:
+If you have used glide to manage dependence,you can also use glide to install Alibaba Cloud SDK for Go
 
 ```sh
 $ glide get github.com/aliyun/alibaba-cloud-sdk-go

+ 6 - 7
README_zh.md

@@ -4,7 +4,7 @@
 <a href=" https://www.alibabacloud.com"><img src="https://aliyunsdk-pages.alicdn.com/icons/Aliyun.svg"></a>
 </p>
 
-<h1 align="center">Alibaba Cloud Go SDK</h1>
+<h1 align="center">Alibaba Cloud SDK for Go</h1>
 
 <p align="center">
 <a href="https://badge.fury.io/gh/aliyun%2Falibaba-cloud-sdk-go"><img src="https://badge.fury.io/gh/aliyun%2Falibaba-cloud-sdk-go.svg" alt="Latest Stable Version"></a>
@@ -17,9 +17,8 @@
 <a href="https://goreportcard.com/report/github.com/aliyun/alibaba-cloud-sdk-go"><img src="https://goreportcard.com/badge/github.com/aliyun/alibaba-cloud-sdk-go" alt="Go Report Card"></a>
 </p>
 
-
-Alibaba Cloud Go SDK 是帮助 Go 开发者管理凭据、发送请求的客户端工具, [Alibaba Cloud Go SDK][SDK] 由本工具提供底层支持。
-
+欢迎使用 Alibaba Cloud SDK for Go。Alibaba Cloud SDK for Go 让您不用复杂编程即可访问云服务器、云监控等多个阿里云服务。
+这里向您介绍如何获取 [Alibaba Cloud SDK for Go][SDK] 并开始调用。
 
 ## 在线示例
 [API Explorer][open-api] 提供在线调用阿里云产品,并动态生成 SDK 代码和快速检索接口等能力,能显著降低使用云 API 的难度。
@@ -28,20 +27,20 @@ Alibaba Cloud Go SDK 是帮助 Go 开发者管理凭据、发送请求的客户
 ## 环境要求
 - 您的系统需要达到 [环境要求][Requirements], 例如,安装了不低于 1.10.x 版本的 Go 环境。
 
-## Installation
+## 安装
 使用 `go get` 下载安装 SDK
 
 ```sh
 $ go get -u github.com/aliyun/alibaba-cloud-sdk-go/sdk
 ```
 
-如果您使用了 glide 管理依赖,您也可以使用 glide 来安装阿里云 GO SDK
+如果您使用了 glide 管理依赖,您也可以使用 glide 来安装 Alibaba Cloud SDK for Go
 
 ```sh
 $ glide get github.com/aliyun/alibaba-cloud-sdk-go
 ```
 
-另外,阿里云 Go SDK 也会发布在 https://develop.aliyun.com/tools/sdk#/go 这个地址。
+另外,Alibaba Cloud SDK for Go 也会发布在 https://develop.aliyun.com/tools/sdk#/go 这个地址。
 
 ## 快速使用
 在您开始之前,您需要注册阿里云帐户并获取您的[凭证](https://usercenter.console.aliyun.com/#/manage/ak)。

+ 1 - 1
docs/0-Requirements-CN.md

@@ -5,7 +5,7 @@
 - Go 环境版本必须不低于 1.10.x.
 
 ## 建议
-- 请确保您的项目中没有其他依赖跟 Alibaba Cloud Go SDK 存在冲突。你可以在[Gopkg.toml](../Gopkg.toml)查看相关的约束。
+- 请确保您的项目中没有其他依赖跟 Alibaba Cloud SDK for Go 存在冲突。你可以在[Gopkg.toml](../Gopkg.toml)查看相关的约束。
 
 ***
 [← 首页](../README_zh.md) | 环境要求[(English)](0-Requirements-EN.md) | [安装 →](1-Installation-CN.md)

+ 1 - 1
docs/0-Requirements-EN.md

@@ -5,7 +5,7 @@
 - You must use Go 1.10.x or later.
 
 ## Recommendations
-- Please make sure there will be no conflict between Alibaba Cloud Go SDK and other. You can see specific constraints in [Gopkg.toml](../Gopkg.toml).
+- Please make sure there will be no conflict between Alibaba Cloud SDK for Go and other. You can see specific constraints in [Gopkg.toml](../Gopkg.toml).
 
 ***
 [← Home](../README.md) | Requirements[(中文)](0-Requirements-CN.md) | [Installation →](1-Installation-EN.md)

+ 2 - 2
docs/1-Installation-CN.md

@@ -8,14 +8,14 @@
 $ go get -u github.com/aliyun/alibaba-cloud-sdk-go/sdk
 ```
 
-如果您使用了 glide 管理依赖,您也可以使用 glide 来安装阿里云GO SDK
+如果您使用了 glide 管理依赖,您也可以使用 glide 来安装 Alibaba Cloud SDK for Go
 
 ```sh
 $ glide get github.com/aliyun/alibaba-cloud-sdk-go
 ```
 
 ## 通过压缩文件安装
-Alibaba Cloud Go SDK 中的一个 ZIP 文件包含运行开发工具包所需的所有类和依赖项。
+Alibaba Cloud SDK for Go 中的一个 ZIP 文件包含运行开发工具包所需的所有类和依赖项。
 下载这个 [文件][Go-release], 然后在项目中的选定位置进行解压缩。
 
 ***

+ 2 - 2
docs/1-Installation-EN.md

@@ -8,14 +8,14 @@ Use `go get` to install SDK:
 $ go get -u github.com/aliyun/alibaba-cloud-sdk-go/sdk
 ```
 
-If you have used glide to manage dependence,you can also use glide to install Alibaba Cloud Go SDK:
+If you have used glide to manage dependence,you can also use glide to install Alibaba Cloud SDK for Go
 
 ```sh
 $ glide get github.com/aliyun/alibaba-cloud-sdk-go
 ```
 
 ## Installing by Using the ZIP file
-The Alibaba Cloud Go SDK includes a ZIP file containing all the classes and dependencies you need to run.
+The Alibaba Cloud SDK for Go includes a ZIP file containing all the classes and dependencies you need to run.
 
 Download the [file][Go-release], and then extract it into your project at a location you choose.
 

+ 5 - 1
docs/2-Client-CN.md

@@ -13,7 +13,6 @@ client, err := sdk.NewClientWithAccessKey("regionId", "accessKeyId", "accessKeyS
 
 ```
 
-
 ### STS 客户端
 通过安全令牌服务(Security Token Service,简称 STS),申请临时安全凭证(Temporary Security Credentials,简称 TSC),创建临时安全客户端。
 
@@ -30,6 +29,11 @@ client, err := sdk.NewClientWithStsToken("regionId", "subaccessKeyId", "subacces
 client, err := sdk.NewClientWithRamRoleArn("regionId", "subaccessKeyId", "subaccessKeySecret", "roleArn", "roleSession")
 ```
 
+如果你想限制生成的 STS Token 的权限([构建Policy][policy]), 你可以使用如下方式创建客户端:
+```go
+client, err := sdk.NewClientWithRamRoleArnAndPolicy("regionId", "subaccessKeyId", "subaccessKeySecret", "roleArn", "roleSession", "policy")
+```
+
 
 ### EcsRamRole 客户端
 通过指定角色名称,让客户端在发起请求前自动申请维护 STS Token,自动转变为一个有时限性的STS客户端。您也可以自行申请维护 STS Token,再创建 `STS客户端`。  

+ 5 - 0
docs/2-Client-EN.md

@@ -33,6 +33,10 @@ By specifying [RAM Role][RAM Role], the client will be able to automatically req
 client, err := sdk.NewClientWithRamRoleArn("regionId", "subaccessKeyId", "subaccessKeySecret", "roleArn", "roleSession")
 ```
 
+If you want to limit the policy([How to make a policy][policy]) of STS Token, you can create a client as following:
+```go
+client, err := sdk.NewClientWithRamRoleArnAndPolicy("regionId", "subaccessKeyId", "subaccessKeySecret", "roleArn", "roleSession", "policy")
+```
 
 ### EcsRamRole Client
 By specifying the role name, the client will be able to automatically request maintenance of STS Token before making a request, and be automatically converted to a time-limited STS client. You may also apply for Token maintenance by yourself before creating `STS Client`.  
@@ -111,5 +115,6 @@ client, err := sdk.NewClientWithProvider("regionId", ProviderInstance, ProviderP
 
 [ak]: https://usercenter.console.aliyun.com/#/manage/ak
 [ram]: https://ram.console.aliyun.com/users
+[policy]: https://www.alibabacloud.com/help/doc-detail/28664.htm?spm=a2c63.p38356.a3.3.27a63b01khWgdh
 [permissions]: https://ram.console.aliyun.com/permissions
 [RAM Role]: https://ram.console.aliyun.com/#/role/list

+ 1 - 1
docs/8-Asynchronous-CN.md

@@ -3,7 +3,7 @@
 ## 异步调用
 
 ### 发起异步调用
-阿里云Go SDK支持两种方式的异步调用:
+Alibaba Cloud SDK for Go 支持两种方式的异步调用:
 
 1. 使用channel作为返回值
     ```go