Skip to content

Commit d8c85db

Browse files
committed
docs: Update README.md and add Chinese version for Agora REST Client
1 parent 998a3a0 commit d8c85db

File tree

2 files changed

+336
-38
lines changed

2 files changed

+336
-38
lines changed

README.md

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -9,45 +9,45 @@
99
<img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues-pr/AgoraIO-Community/agora-rest-client-java">
1010
</p>
1111

12-
`agora-rest-client-java`是用 Java 语言编写的一个开源项目,专门为 Agora REST API 设计。它包含了 Agora 官方提供的 REST
13-
API 接口的包装和内部实现,可以帮助开发者更加方便的集成服务端 Agora REST API。
12+
`agora-rest-client-java`is an open-source project written in Java, specifically designed for the Agora REST API. It includes wrappers and internal implementations of the official Agora REST API interfaces, making it easier for developers to integrate the server-side Agora REST API.
1413

1514
> [!IMPORTANT]
16-
该SDK经过一些测试以确保其基本功能正常运作。然而,由于软件开发的复杂性,我们无法保证它是完全没有缺陷的,我们鼓励社区的开发者和用户积极参与,共同改进这个项目。
15+
This SDK has undergone some testing to ensure its basic functionality works correctly. However, due to the complexity of software development, we cannot guarantee it is completely free of defects. We encourage community developers and users to actively participate and help improve this project.
1716

18-
## 特性
17+
## Features
1918

20-
* 封装了 Agora REST API 的请求和响应处理,简化与 Agora REST API 的通信流程
21-
* 当遇到 DNS 解析失败、网络错误或者请求超时等问题的时候,提供了自动切换最佳域名的能力,以保障请求 REST API 服务的可用性
22-
* 提供了易于使用的 API,可轻松地实现调用 Agora REST API 的常见功能,如开启云录制、停止云录制等
23-
* 基于 Java 语言,具有异步性、并发性和可扩展性
19+
* Encapsulates the request and response handling of the Agora REST API, simplifying the communication process with the Agora REST API.
20+
* Provides automatic switching to the best domain in case of DNS resolution failure, network errors, or request timeouts, ensuring the availability of the REST API service.
21+
* Offers easy-to-use APIs to easily implement common functions of the Agora REST API, such as starting and stopping cloud recording.
22+
* Based on Java language, it is efficient, concurrent, and scalable.
2423

25-
## 支持的服务
24+
## Supported Services
2625

27-
* [云端录制 Cloud Recording ](./agora-rest-client-core/src/main/java/io/agora/rest/services/cloudrecording/README.md)
26+
* [Cloud Recording](./agora-rest-client-core/src/main/java/io/agora/rest/services/cloudrecording/README.md)
27+
* [Conversational AI Engine](./agora-rest-client-core/src/main/java/io/agora/rest/services/convoai/README.md)
28+
29+
## Environment Setup
2830

29-
## 环境准备
31+
* [Java 1.8 or later](https://www.java.com)
32+
* App ID and App Certificate obtained from the [Agora Console](https://console.shengwang.cn/)
33+
* Basic Auth credentials from the [Agora Console](https://console.shengwang.cn/)
34+
* Enable the relevant service capabilities on the [Agora Console](https://console.shengwang.cn/)
3035

31-
* [Java 1.8 或以上版本](https://www.java.com)
32-
* 在声网 [Console 平台](https://console.shengwang.cn/)申请的 App ID 和 App Certificate
33-
* 在声网 [Console 平台](https://console.shengwang.cn/)的 Basic Auth 认证信息
34-
* 在声网 [Console 平台](https://console.shengwang.cn/)开启相关的服务能力
36+
## Installation
3537

36-
## 安装
37-
38-
首先,在`poml.xml`文件中添加 REST Client 依赖:
38+
First, add the REST Client dependency in the `pom.xml` file:
3939

4040
```xml
4141
<dependency>
4242
<groupId>io.agora</groupId>
4343
<artifactId>agora-rest-client-core</artifactId>
44-
<version>0.2.0</version>
44+
<version>0.3.0</version>
4545
</dependency>
4646
```
4747

48-
## 使用示例
48+
## Usage Example
4949

50-
以调用云录制服务为例:
50+
Here is an example of calling the cloud recording service:
5151

5252
```java
5353
package com.company.example;
@@ -260,36 +260,36 @@ public class Main {
260260

261261
```
262262

263-
更多的示例可在 [Example](./examples) 查看
263+
For more examples, see [Example](./examples).
264264

265-
## 集成遇到困难,该如何联系声网获取协助
265+
## How to Contact Agora for Assistance if You Encounter Difficulties
266266

267-
> 方案1:如果您已经在使用声网服务或者在对接中,可以直接联系对接的销售或服务
267+
> Option 1: If you are already using Agora services or are in the process of integration, you can directly contact your sales or service representative.
268268
>
269-
> 方案2:发送邮件给 [[email protected]](mailto:[email protected]) 咨询
269+
> Option 2: Send an email to [[email protected]](mailto:[email protected]) for consultation.
270270
>
271-
> 方案3:扫码加入我们的微信交流群提问
271+
> Option 3: Scan the QR code to join our WeChat group for questions.
272272
>
273273
> <img src="https://download.agora.io/demo/release/SDHY_QA.jpg" width="360" height="360">
274274
---
275275

276-
## 贡献
276+
## Contribution
277277

278-
本项目欢迎并接受贡献。如果您在使用中遇到问题或有改进建议,请提出 issue 或向我们提交 Pull Request
278+
This project welcomes and accepts contributions. If you encounter any issues or have suggestions for improvements, please open an issue or submit a Pull Request.
279279

280-
# SemVer 版本规范
280+
# SemVer Versioning
281281

282-
本项目使用语义化版本号规范 (SemVer) 来管理版本。格式为 MAJOR.MINOR.PATCH
282+
This project uses Semantic Versioning (SemVer) to manage versions. The format is MAJOR.MINOR.PATCH.
283283

284-
* MAJOR 版本号表示不向后兼容的重大更改。
285-
* MINOR 版本号表示向后兼容的新功能或增强。
286-
* PATCH 版本号表示向后兼容的错误修复和维护。
287-
有关详细信息,请参阅 [语义化版本](https://semver.org/lang/zh-CN/) 规范。
284+
* MAJOR version indicates incompatible changes.
285+
* MINOR version indicates backward-compatible new features or enhancements.
286+
* PATCH version indicates backward-compatible bug fixes and maintenance.
287+
For more details, please refer to the [Semantic Versioning](https://semver.org) specification.
288288

289-
## 参考
289+
## References
290290

291-
* [Agora API 文档](https://doc.shengwang.cn/)
291+
* [Agora API Documentation](https://doc.shengwang.cn/)
292292

293-
## 许可证
293+
## License
294294

295-
该项目使用MIT许可证,详细信息请参阅LICENSE文件。
295+
This project is licensed under the MIT License. For more details, please refer to the LICENSE file.

0 commit comments

Comments
 (0)