Skip to content

Commit 45d82c9

Browse files
JacksonTianJacksonTian
committed
improve readme
1 parent 93f5511 commit 45d82c9

File tree

2 files changed

+54
-64
lines changed

2 files changed

+54
-64
lines changed

‎README-CN.md

+26-31
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,38 @@
11
[English](./README.md) | 简体中文
22

3-
43
<p align="center">
54
<a href=" https://www.alibabacloud.com"><img src="https://aliyunsdk-pages.alicdn.com/icons/Aliyun.svg"></a>
65
</p>
76

87
<h1 align="center">Alibaba Cloud SDK for .NET</h1>
98

10-
<p align="center">
11-
<a href="https://travis-ci.org/aliyun/aliyun-openapi-net-sdk"><img src="https://travis-ci.org/aliyun/aliyun-openapi-net-sdk.svg?branch=master" alt="Travis Build Status"></a>
12-
<a href="https://ci.appveyor.com/project/aliyun/aliyun-openapi-net-sdk"><img src="https://ci.appveyor.com/api/projects/status/32r7s2skrgm9ubva?svg=true" alt="Appveyor Build Status"></a>
13-
<a href="https://app.fossa.io/projects/git%2Bgithub.com%2Faliyun%2Faliyun-openapi-net-sdk?ref=badge_shield" alt="FOSSA Status"><img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Faliyun%2Faliyun-openapi-net-sdk.svg?type=shield"/></a>
14-
<a href="https://codecov.io/gh/aliyun/aliyun-openapi-net-sdk"><img src="https://codecov.io/gh/aliyun/aliyun-openapi-net-sdk/branch/master/graph/badge.svg" alt="Codecov"></a>
15-
<a href="https://badge.fury.io/nu/aliyun-net-sdk-core"><img src="https://badge.fury.io/nu/aliyun-net-sdk-core.svg" alt="Nuget Version"></a>
16-
<a href="https://www.nuget.org/packages/aliyun-net-sdk-core/"><img src="https://img.shields.io/nuget/dt/aliyun-net-sdk-core.svg?label=Nuget%20Download&style=flat" alt="Nuget Version"></a>
17-
<a href="https://github.com/aliyun/aliyun-openapi-net-sdk/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="Nuget Version"></a>
18-
</p>
19-
9+
[![.NET CI](https://github.com/aliyun/aliyun-openapi-net-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/aliyun/aliyun-openapi-net-sdk/actions/workflows/ci.yml)
10+
[![codecov](https://codecov.io/gh/aliyun/aliyun-openapi-net-sdk/graph/badge.svg?token=TiTJg3ch1j)](https://codecov.io/gh/aliyun/aliyun-openapi-net-sdk)
11+
[![Nuget Version](https://badge.fury.io/nu/aliyun-net-sdk-core.svg)](https://www.nuget.org/packages/aliyun-net-sdk-core/)
12+
[![Nuget Download](https://img.shields.io/nuget/dt/aliyun-net-sdk-core.svg?label=Nuget%20Download&style=flat)](https://www.nuget.org/packages/aliyun-net-sdk-core/)
13+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/aliyun/aliyun-openapi-net-sdk/blob/master/LICENSE)
14+
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Faliyun%2Faliyun-openapi-net-sdk.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Faliyun%2Faliyun-openapi-net-sdk?ref=badge_shield)
2015

2116
欢迎使用 Alibaba Cloud SDK for .NET ，让您不用复杂编程即可访问云服务器、云监控等多个阿里云服务。
2217

23-
2418
## 使用诊断
25-
[Troubleshoot](https://troubleshoot.api.aliyun.com/?source=github_sdk) 提供 OpenAPI 使用诊断服务，通过 `RequestID` 或 `报错信息` ，帮助开发者快速定位，为开发者提供解决方案。
2619

20+
[Troubleshoot](https://api.aliyun.com/troubleshoot?source=github_sdk) 提供 OpenAPI 使用诊断服务，通过 `RequestID` 或 `报错信息` ，帮助开发者快速定位，为开发者提供解决方案。
2721

2822
## 使用Demo及其示例
29-
您可以在 [阿里云 OpenAPI 开发者门户](https://next.api.aliyun.com) 中查看您所使用的产品代码示例。
3023

24+
您可以在 [阿里云 OpenAPI 开发者门户](https://api.aliyun.com/) 中查看您所使用的产品代码示例。
3125

3226
## 环境要求
27+
3328
Alibaba Cloud SDK for .NET 适用于:
29+
3430
- **.NET Framework 4.5** 及其以上版本
3531
- **.NET Standard 2.0** 及其以上版本。
3632
- **C# 4.0** 及其以上版本
3733

38-
3934
## 安装
35+
4036
进入 [Alibaba Cloud SDK for .NET Nuget Package](https://www.nuget.org/profiles/aliyun-openapi-sdk) 页面，查看已发布的阿里云产品 SDK 模块列表。
4137

4238
> **注意：** 部分阿里云产品的 SDK 未收录到这个列表中，例如对象存储（OSS），表格存储（Table Store），请前往这些产品的详情页获取相应的 SDK。
@@ -46,14 +42,14 @@ Alibaba Cloud SDK for .NET 适用于:
4642

4743
您可以通过 NuGet 程序包管理器来安装：
4844

49-
* 在 `解决方案资源管理器面板` 中右击您的项目选择 `管理 NuGet 程序包` 菜单，在打开的 `NuGet 管理面板` 中点击 `浏览` 选项卡输入 `aliyun-net-sdk`，在下方列表中选择 `Authors` 为 `Alibaba Cloud` 由官方发布的各产品模块，选择您期望的模块点击 **安装** 即可。
45+
- 在 `解决方案资源管理器面板` 中右击您的项目选择 `管理 NuGet 程序包` 菜单，在打开的 `NuGet 管理面板` 中点击 `浏览` 选项卡输入 `aliyun-net-sdk`，在下方列表中选择 `Authors` 为 `Alibaba Cloud` 由官方发布的各产品模块，选择您期望的模块点击 **安装** 即可。
5046

5147
或者通过 .NET CLI 工具来安装（以安装 ECS为例）
5248

5349
dotnet add package aliyun-net-sdk-ecs
5450

55-
5651
## 快速开始
52+
5753
- 要使用 Alibaba Cloud SDK for .NET，您需要一个云账号以及一对 Access Key ID 和 Access Key Secret。请在阿里云控制台中的 [AccessKey 管理页面](https://usercenter.console.aliyun.com/#/manage/ak) 上创建和查看您的 Access Key，或者联系您的系统管理员。
5854

5955
- 要使用 Alibaba Cloud SDK for .NET 访问某个产品的 API，您需要事先在 [阿里云控制台](https://home.console.aliyun.com/new#/) 中开通这个产品。
@@ -147,33 +143,32 @@ class Program
147143
}
148144
```
149145

150-
151146
## 文档
152-
* [环境要求](docs/0-Requirements-CN.md)
153-
* [SSL 验证](docs/1-Verify-CN.md)
154-
* [调试](docs/2-Debug-CN.md)
155-
* [代理](docs/3-Proxy-CN.md)
156-
* [超时](docs/4-Timeout-CN.md)
157-
* [产品Nuget包](docs/5-Packages-CN.md)
158-
* [日志](docs/6-Log-CN.md)
159-
* [客户端与凭证](docs/7-Client-CN.md)
160-
* [Endpoint](docs/8-Endpoint-CN.md)
161147

148+
- [环境要求](docs/0-Requirements-CN.md)
149+
- [SSL 验证](docs/1-Verify-CN.md)
150+
- [调试](docs/2-Debug-CN.md)
151+
- [代理](docs/3-Proxy-CN.md)
152+
- [超时](docs/4-Timeout-CN.md)
153+
- [产品Nuget包](docs/5-Packages-CN.md)
154+
- [日志](docs/6-Log-CN.md)
155+
- [客户端与凭证](docs/7-Client-CN.md)
156+
- [Endpoint](docs/8-Endpoint-CN.md)
162157

163158
## 问题
164-
[提交Issue](https://github.com/aliyun/aliyun-openapi-net-sdk/issues/new)，不符合指南的问题可能会立即关闭。
165159

160+
[提交Issue](https://github.com/aliyun/aliyun-openapi-net-sdk/issues/new)，不符合指南的问题可能会立即关闭。
166161

167162
## 发行说明
168-
每个版本的详细更改记录在 [发行说明](aliyun-net-sdk-core/ChangeLog.md) 中。
169163

164+
每个版本的详细更改记录在 [发行说明](aliyun-net-sdk-core/ChangeLog.md) 中。
170165

171166
## API参考
172-
要知道您想访问的产品提供的 API 以及它们的参数，请参考开放 API 的 [产品列表](https://develop.aliyun.com/tools/openapilist)。
173167

168+
要知道您想访问的产品提供的 API 以及它们的参数，请参考开放 API 的 [产品列表](https://develop.aliyun.com/tools/openapilist)。
174169

175170
## 许可证
176-
源码基于 [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) 许可协议开放授权
177171

172+
源码基于 [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) 许可协议开放授权
178173

179174
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Faliyun%2Faliyun-openapi-net-sdk.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Faliyun%2Faliyun-openapi-net-sdk?ref=badge_large)

‎README.md

+28-33
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,37 @@
11
English | [简体中文](./README-CN.md)
22

3-
43
<p align="center">
54
<a href=" https://www.alibabacloud.com"><img src="https://aliyunsdk-pages.alicdn.com/icons/AlibabaCloud.svg"></a>
65
</p>
76

87
<h1 align="center">Alibaba Cloud SDK for .NET</h1>
98

10-
<p align="center">
11-
<a href="https://travis-ci.org/aliyun/aliyun-openapi-net-sdk"><img src="https://travis-ci.org/aliyun/aliyun-openapi-net-sdk.svg?branch=master" alt="Travis Build Status"></a>
12-
<a href="https://ci.appveyor.com/project/aliyun/aliyun-openapi-net-sdk"><img src="https://ci.appveyor.com/api/projects/status/32r7s2skrgm9ubva?svg=true" alt="Appveyor Build Status"></a>
13-
<a href="https://app.fossa.io/projects/git%2Bgithub.com%2Faliyun%2Faliyun-openapi-net-sdk?ref=badge_shield" alt="FOSSA Status"><img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Faliyun%2Faliyun-openapi-net-sdk.svg?type=shield"/></a>
14-
<a href="https://codecov.io/gh/aliyun/aliyun-openapi-net-sdk"><img src="https://codecov.io/gh/aliyun/aliyun-openapi-net-sdk/branch/master/graph/badge.svg" alt="Codecov"></a>
15-
<a href="https://badge.fury.io/nu/aliyun-net-sdk-core"><img src="https://badge.fury.io/nu/aliyun-net-sdk-core.svg" alt="Nuget Version"></a>
16-
<a href="https://www.nuget.org/packages/aliyun-net-sdk-core/"><img src="https://img.shields.io/nuget/dt/aliyun-net-sdk-core.svg?label=Nuget%20Download&style=flat" alt="Nuget Version"></a>
17-
<a href="https://github.com/aliyun/aliyun-openapi-net-sdk/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="Nuget Version"></a>
18-
</p>
19-
9+
[![.NET CI](https://github.com/aliyun/aliyun-openapi-net-sdk/actions/workflows/ci.yml/badge.svg)](https://github.com/aliyun/aliyun-openapi-net-sdk/actions/workflows/ci.yml)
10+
[![codecov](https://codecov.io/gh/aliyun/aliyun-openapi-net-sdk/graph/badge.svg?token=TiTJg3ch1j)](https://codecov.io/gh/aliyun/aliyun-openapi-net-sdk)
11+
[![Nuget Version](https://badge.fury.io/nu/aliyun-net-sdk-core.svg)](https://www.nuget.org/packages/aliyun-net-sdk-core/)
12+
[![Nuget Download](https://img.shields.io/nuget/dt/aliyun-net-sdk-core.svg?label=Nuget%20Download&style=flat)](https://www.nuget.org/packages/aliyun-net-sdk-core/)
13+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/aliyun/aliyun-openapi-net-sdk/blob/master/LICENSE)
14+
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Faliyun%2Faliyun-openapi-net-sdk.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Faliyun%2Faliyun-openapi-net-sdk?ref=badge_shield)
2015

2116
The Alibaba Cloud SDK for .NET allows you to access Alibaba Cloud services such as Elastic Compute Service (ECS), Server Load Balancer (SLB), CloudMonitor, etc. You can access Alibaba Cloud services without the need to handle API related tasks, such as signing and constructing your requests.
2217

23-
2418
## Troubleshoot
25-
[Troubleshoot](https://troubleshoot.api.aliyun.com/?source=github_sdk) Provide OpenAPI diagnosis service to help developers locate quickly and provide solutions for developers through `RequestID` or `error message`.
2619

20+
[Troubleshoot](https://api.aliyun.com/troubleshoot?source=github_sdk) Provide OpenAPI diagnosis service to help developers locate quickly and provide solutions for developers through `RequestID` or `error message`.
2721

2822
## Online Demo
29-
[OpenAPI Workbench](https://next.api.aliyun.com) provides the ability to call the cloud product OpenAPI online, generates SDK Example code dynamically and retrieves interface quickly, which can lessen the difficultly of using the Alibaba Cloud API significantly.
3023

24+
[Alibaba Cloud OpenAPI Developer Portal](https://api.aliyun.com) provides the ability to call the cloud product OpenAPI online, generates SDK Example code dynamically and retrieves interface quickly, which can lessen the difficultly of using the Alibaba Cloud API significantly.
3125

3226
## Requirements
33-
- The Alibaba Cloud SDK for .NET requires：
34-
- **.NET Framework 4.5** and above
35-
- **.NET Standard 2.0** and above
36-
- **C# 4.0** and above
3727

28+
- The Alibaba Cloud SDK for .NET requires：
29+
- **.NET Framework 4.5** and above
30+
- **.NET Standard 2.0** and above
31+
- **C# 4.0** and above
3832

3933
## Installation
34+
4035
You should install [ECS Nuget Package](https://www.nuget.org/packages/aliyun-net-sdk-ecs/) when you are using ECS Product. If you want to install a specific version, please add `--version` or it will install the latest version of this package.
4136

4237
Use .NET CLI ( Recommand )
@@ -47,8 +42,8 @@ Use Package Manager
4742

4843
Install-Package aliyun-net-sdk-ecs
4944

50-
5145
## Quick Examples
46+
5247
At the beginning, you need to sign up for an Alibaba Cloud account and retrieve your [Credentials](https://usercenter.console.aliyun.com/#/manage/ak).
5348
>**Note:** To increase the security of your account, we recommend that you can use the AccessKey of the RAM user to access Alibaba Cloud services.
5449
@@ -102,6 +97,7 @@ class Program
10297
```
10398

10499
### Use BearerToken to invoke [CCC](https://www.nuget.org/packages/aliyun-net-sdk-ccc/) Product
100+
105101
You should install the [CCC Product Nuget Package](https://www.nuget.org/packages/aliyun-net-sdk-ccc/) if you want to run the below demo in your local machine.
106102

107103
```csharp
@@ -142,33 +138,32 @@ class Program
142138
}
143139
```
144140

145-
146141
## Documentation
147-
* [Requirements](docs/0-Requirements-EN.md)
148-
* [SSL Verify](docs/1-Verify-EN.md)
149-
* [Debug](docs/2-Debug-EN.md)
150-
* [Proxy](docs/3-Proxy-EN.md)
151-
* [Timeout](docs/4-Timeout-EN.md)
152-
* [Product Nuget Package](docs/5-Packages-EN.md)
153-
* [Log](docs/6-Log-EN.md)
154-
* [Client & Credentials](docs/7-Client-EN.md)
155-
* [Endpoint](docs/8-Endpoint-EN.md)
156142

143+
- [Requirements](docs/0-Requirements-EN.md)
144+
- [SSL Verify](docs/1-Verify-EN.md)
145+
- [Debug](docs/2-Debug-EN.md)
146+
- [Proxy](docs/3-Proxy-EN.md)
147+
- [Timeout](docs/4-Timeout-EN.md)
148+
- [Product Nuget Package](docs/5-Packages-EN.md)
149+
- [Log](docs/6-Log-EN.md)
150+
- [Client & Credentials](docs/7-Client-EN.md)
151+
- [Endpoint](docs/8-Endpoint-EN.md)
157152

158153
## Issues
159-
[Opening an Issue](https://github.com/aliyun/aliyun-openapi-net-sdk/issues/new), Issues not conforming to the guidelines may be closed immediately.
160154

155+
[Opening an Issue](https://github.com/aliyun/aliyun-openapi-net-sdk/issues/new), Issues not conforming to the guidelines may be closed immediately.
161156

162157
## Changelog
163-
Detailed changes for each release are documented in the [release notes](aliyun-net-sdk-core/ChangeLog.md).
164158

159+
Detailed changes for each release are documented in the [release notes](aliyun-net-sdk-core/ChangeLog.md).
165160

166161
## API Reference
167-
You can visit the API and its parameters in [Product List](https://www.alibabacloud.com).
168162

163+
You can visit the API and its parameters in [Product List](https://www.alibabacloud.com).
169164

170165
## License
171-
[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
172166

167+
[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
173168

174169
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Faliyun%2Faliyun-openapi-net-sdk.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Faliyun%2Faliyun-openapi-net-sdk?ref=badge_large)

0 commit comments

Comments
 (0)