version

README-CN.md

@@ -0,0 +1,168 @@
+# Aliyun OSS SDK for Go
+
+[![GitHub version](https://badge.fury.io/gh/aliyun%2Faliyun-oss-go-sdk.svg)](https://badge.fury.io/gh/aliyun%2Faliyun-oss-go-sdk)
+[![Build Status](https://travis-ci.org/aliyun/aliyun-oss-go-sdk.svg?branch=master)](https://travis-ci.org/aliyun/aliyun-oss-go-sdk)
+[![Coverage Status](https://coveralls.io/repos/github/aliyun/aliyun-oss-go-sdk/badge.svg?branch=master)](https://coveralls.io/github/aliyun/aliyun-oss-go-sdk?branch=master)
+
+## [README of English][readme.md]
+
+## 关于
+> - 此Go SDK基于[阿里云对象存储服务](http://www.aliyun.com/product/oss/)官方API构建。
+> - 阿里云对象存储（Object Storage Service，简称OSS），是阿里云对外提供的海量，安全，低成本，高可靠的云存储服务。
+> - OSS适合存放任意文件类型，适合各种网站、开发企业及开发者使用。
+> - 使用此SDK，用户可以方便地在任何应用、任何时间、任何地点上传，下载和管理数据。
+
+## 版本
+> - 当前版本：1.4.0
+
+## 运行环境
+> - 推荐使用Go 1.4及以上。
+
+## 安装方法
+### GitHub安装
+> - 执行命令`go get github.com/aliyun/aliyun-oss-go-sdk/oss`获取远程代码包。
+> - 在您的代码中使用`import "github.com/aliyun/aliyun-oss-go-sdk/oss"`引入OSS Go SDK的包。
+
+## 快速使用
+#### 获取存储空间列表（List Bucket）
+```go
+    client, err := oss.New("Endpoint", "AccessKeyId", "AccessKeySecret")
+    if err != nil {
+        // HandleError(err)
+    }
+    
+    lsRes, err := client.ListBuckets()
+    if err != nil {
+        // HandleError(err)
+    }
+    
+    for _, bucket := range lsRes.Buckets {
+        fmt.Println("Buckets:", bucket.Name)
+    }
+```
+
+#### 创建存储空间（Create Bucket）
+```go
+    client, err := oss.New("Endpoint", "AccessKeyId", "AccessKeySecret")
+    if err != nil {
+        // HandleError(err)
+    }
+    
+    err = client.CreateBucket("my-bucket")
+    if err != nil {
+        // HandleError(err)
+    }
+```
+    
+#### 删除存储空间（Delete Bucket）
+```go
+    client, err := oss.New("Endpoint", "AccessKeyId", "AccessKeySecret")
+    if err != nil {
+        // HandleError(err)
+    }
+    
+    err = client.DeleteBucket("my-bucket")
+    if err != nil {
+        // HandleError(err)
+    }
+```
+
+#### 上传文件（Put Object）
+```go
+    client, err := oss.New("Endpoint", "AccessKeyId", "AccessKeySecret")
+    if err != nil {
+        // HandleError(err)
+    }
+    
+    bucket, err := client.Bucket("my-bucket")
+    if err != nil {
+        // HandleError(err)
+    }
+    
+    err = bucket.PutObjectFromFile("my-object", "LocalFile")
+    if err != nil {
+        // HandleError(err)
+    }
+```
+
+#### 下载文件 (Get Object)
+```go
+    client, err := oss.New("Endpoint", "AccessKeyId", "AccessKeySecret")
+    if err != nil {
+        // HandleError(err)
+    }
+    
+    bucket, err := client.Bucket("my-bucket")
+    if err != nil {
+        // HandleError(err)
+    }
+    
+    err = bucket.GetObjectToFile("my-object", "LocalFile")
+    if err != nil {
+        // HandleError(err)
+    }
+```
+
+#### 获取文件列表（List Objects）
+```go
+    client, err := oss.New("Endpoint", "AccessKeyId", "AccessKeySecret")
+    if err != nil {
+        // HandleError(err)
+    }
+    
+    bucket, err := client.Bucket("my-bucket")
+    if err != nil {
+        // HandleError(err)
+    }
+    
+    lsRes, err := bucket.ListObjects()
+    if err != nil {
+        // HandleError(err)
+    }
+    
+    for _, object := range lsRes.Objects {
+        fmt.Println("Objects:", object.Key)
+    }
+```
+    
+#### 删除文件(Delete Object)
+```go
+    client, err := oss.New("Endpoint", "AccessKeyId", "AccessKeySecret")
+    if err != nil {
+        // HandleError(err)
+    }
+    
+    bucket, err := client.Bucket("my-bucket")
+    if err != nil {
+        // HandleError(err)
+    }
+    
+    err = bucket.DeleteObject("my-object")
+    if err != nil {
+        // HandleError(err)
+    }
+```
+
+#### 其它
+更多的示例程序，请参看OSS Go SDK安装路径（即GOPATH变量中的第一个路径）下的`src\github.com\aliyun\aliyun-oss-go-sdk\sample`，该目录下为示例程序，
+或者参看`https://github.com/aliyun/aliyun-oss-go-sdk`下sample目录中的示例文件。
+
+## 注意事项
+### 运行sample
+> - 拷贝示例文件。到OSS Go SDK的安装路径（即GOPATH变量中的第一个路径），进入OSS Go SDK的代码目录`src\github.com\aliyun\aliyun-oss-go-sdk`，
+把其下的sample目录和sample.go复制到您的测试工程src目录下。
+> - 修改sample/config.go里的endpoint、AccessKeyId、AccessKeySecret、BucketName等配置。
+> - 请在您的工程目录下执行`go run src/sample.go`。
+
+## 联系我们
+> - [阿里云OSS官方网站](http://oss.aliyun.com)
+> - [阿里云OSS官方论坛](http://bbs.aliyun.com)
+> - [阿里云OSS官方文档中心](http://www.aliyun.com/product/oss#Docs)
+> - 阿里云官方技术支持：[提交工单](https://workorder.console.aliyun.com/#/ticket/createIndex)
+
+## 作者
+> - Yubin Bai
+> - Hǎiliàng Wáng
+
+## License
+> - Apache License 2.0

README.md

@@ -1,26 +1,30 @@
-# Aliyun OSS SDK for Go
-[![GitHub version](https://badge.fury.io/gh/aliyun%2Faliyun-oss-go-sdk.svg)](https://badge.fury.io/gh/aliyun%2Faliyun-oss-go-sdk)
+# Alibaba Cloud OSS SDK for Go
+
+[![GitHub Version](https://badge.fury.io/gh/aliyun%2Faliyun-oss-go-sdk.svg)](https://badge.fury.io/gh/aliyun%2Faliyun-oss-go-sdk)
 [![Build Status](https://travis-ci.org/aliyun/aliyun-oss-go-sdk.svg?branch=master)](https://travis-ci.org/aliyun/aliyun-oss-go-sdk)
 [![Coverage Status](https://coveralls.io/repos/github/aliyun/aliyun-oss-go-sdk/badge.svg?branch=master)](https://coveralls.io/github/aliyun/aliyun-oss-go-sdk?branch=master)
-## 关于
-> - 此Go SDK基于[阿里云对象存储服务](http://www.aliyun.com/product/oss/)官方API构建。
-> - 阿里云对象存储（Object Storage Service，简称OSS），是阿里云对外提供的海量，安全，低成本，高可靠的云存储服务。
-> - OSS适合存放任意文件类型，适合各种网站、开发企业及开发者使用。
-> - 使用此SDK，用户可以方便地在任何应用、任何时间、任何地点上传，下载和管理数据。
 
-## 版本
-> - 当前版本：1.4.0
+## [README of Chinese][readme-cn.md]
+
+## About
+> - This Go SDK is based on the official APIs of [Alibaba Cloud OSS](http://www.aliyun.com/product/oss/).
+> - Alibaba Cloud Object Storage Service (OSS) is a cloud storage service provided by Alibaba Cloud, featuring massive capacity, security, a low cost, and high reliability. 
+> - The OSS can store any type of files and therefore applies to various websites, development enterprises and developers.
+> - With this SDK, you can upload, download and manage data on any app anytime and anywhere conveniently. 
+
+## Version
+> - Current version: 1.4.0. 
 
-## 运行环境
-> - 推荐使用Go 1.4及以上。
+## Run environment
+> - Go 1.4 or above is recommended. 
 
-## 安装方法
-### GitHub安装
-> - 执行命令`go get github.com/aliyun/aliyun-oss-go-sdk/oss`获取远程代码包。
-> - 在您的代码中使用`import "github.com/aliyun/aliyun-oss-go-sdk/oss"`引入OSS Go SDK的包。
+## Install OSS Go SDK
+### Install the SDK through GitHub
+> -Run the 'go get github.com/aliyun/aliyun-oss-go-sdk/oss' command to get the remote code package.
+> - Use 'import "github.com/aliyun/aliyun-oss-go-sdk/oss"' in your code to introduce OSS Go SDK package.
 
-## 快速使用
-#### 获取存储空间列表（List Bucket）
+## Quick use
+#### Get the bucket list (List Bucket)
 ```go
     client, err := oss.New("Endpoint", "AccessKeyId", "AccessKeySecret")
     if err != nil {
@@ -37,7 +41,7 @@
     }
 ```
 
-#### 创建存储空间（Create Bucket）
+#### Create a bucket (Create Bucket)
 ```go
     client, err := oss.New("Endpoint", "AccessKeyId", "AccessKeySecret")
     if err != nil {
@@ -50,7 +54,7 @@
     }
 ```
     
-#### 删除存储空间（Delete Bucket）
+#### Delete a bucket (Delete Bucket)
 ```go
     client, err := oss.New("Endpoint", "AccessKeyId", "AccessKeySecret")
     if err != nil {
@@ -63,7 +67,7 @@
     }
 ```
 
-#### 上传文件（Put Object）
+#### Upload a file (Put Object)
 ```go
     client, err := oss.New("Endpoint", "AccessKeyId", "AccessKeySecret")
     if err != nil {
@@ -81,7 +85,7 @@
     }
 ```
 
-#### 下载文件 (Get Object)
+#### Download an object (Get Object)
 ```go
     client, err := oss.New("Endpoint", "AccessKeyId", "AccessKeySecret")
     if err != nil {
@@ -99,7 +103,7 @@
     }
 ```
 
-#### 获取文件列表（List Objects）
+#### Get the object list (List Objects)
 ```go
     client, err := oss.New("Endpoint", "AccessKeyId", "AccessKeySecret")
     if err != nil {
@@ -121,7 +125,7 @@
     }
 ```
     
-#### 删除文件(Delete Object)
+#### Delete an object (Delete Object)
 ```go
     client, err := oss.New("Endpoint", "AccessKeyId", "AccessKeySecret")
     if err != nil {
@@ -139,26 +143,26 @@
     }
 ```
 
-#### 其它
-更多的示例程序，请参看OSS Go SDK安装路径（即GOPATH变量中的第一个路径）下的`src\github.com\aliyun\aliyun-oss-go-sdk\sample`，该目录下为示例程序，
-或者参看`https://github.com/aliyun/aliyun-oss-go-sdk`下sample目录中的示例文件。
+#### Others
+More example projects can be found at 'src\github.com\aliyun\aliyun-oss-go-sdk\sample' under the installation path of the OSS Go SDK (the first path of the GOPATH variable). The directory contains example projects. 
+Or you can refer to the example objects in the sample directory under 'https://github.com/aliyun/aliyun-oss-go-sdk'.
 
-## 注意事项
-### 运行sample
-> - 拷贝示例文件。到OSS Go SDK的安装路径（即GOPATH变量中的第一个路径），进入OSS Go SDK的代码目录`src\github.com\aliyun\aliyun-oss-go-sdk`，
-把其下的sample目录和sample.go复制到您的测试工程src目录下。
-> - 修改sample/config.go里的endpoint、AccessKeyId、AccessKeySecret、BucketName等配置。
-> - 请在您的工程目录下执行`go run src/sample.go`。
+## Notes
+### Run a sample project
+> - Copy the example file. Go to the installation path of OSS Go SDK (the first path of the GOPATH variable), enter the code directory of the OSS Go SDK, namely 'src\github.com\aliyun\aliyun-oss-go-sdk',
+and copy the sample directory and sample.go to the src directory of your test project.
+> - Modify the  endpoint, AccessKeyId, AccessKeySecret and BucketName configuration settings in sample/config.go.
+> - Run 'go run src/sample.go' under your project directory.
 
-## 联系我们
-> - [阿里云OSS官方网站](http://oss.aliyun.com)
-> - [阿里云OSS官方论坛](http://bbs.aliyun.com)
-> - [阿里云OSS官方文档中心](http://www.aliyun.com/product/oss#Docs)
-> - 阿里云官方技术支持：[提交工单](https://workorder.console.aliyun.com/#/ticket/createIndex)
+## Contact us
+> - [Alibaba Cloud OSS official website](http://oss.aliyun.com).
+> - [Alibaba Cloud OSS official forum](http://bbs.aliyun.com).
+> - [Alibaba Cloud OSS official documentation center](http://www.aliyun.com/product/oss#Docs).
+> - Alibaba Cloud official technical support: [Submit a ticket](https://workorder.console.aliyun.com/#/ticket/createIndex). 
 
-## 作者
-> - Yubin Bai
-> - Hǎiliàng Wáng
+## Author
+> - Yubin Bai.
+> - Hǎiliàng Wáng.
 
 ## License
-> - Apache License 2.0
+> - Apache License 2.0.