Skip to content

Commit 7b9b2c3

Browse files
xuthus5nobodyiam
authored andcommitted
chore: add readme english version
Signed-off-by: Young Xu <[email protected]>
1 parent 41e433a commit 7b9b2c3

File tree

2 files changed

+118
-21
lines changed

2 files changed

+118
-21
lines changed

README.md

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
Agollo - Go Client for Apollo
22
================
3+
English | [中文](/README_CN.md)
34

45
[![golang](https://img.shields.io/badge/Language-Go-green.svg?style=flat)](https://golang.org)
56
[![Build Status](https://github.com/apolloconfig/agollo/actions/workflows/go.yml/badge.svg)](https://github.com/apolloconfig/agollo/actions/workflows/go.yml)
@@ -11,35 +12,36 @@ Agollo - Go Client for Apollo
1112
[![GitHub release](https://img.shields.io/github/release/apolloconfig/agollo.svg)](https://github.com/apolloconfig/apolloconfig/releases)
1213
[![996.icu](https://img.shields.io/badge/link-996.icu-red.svg)](https://996.icu)
1314

14-
方便Golang接入配置中心框架 [Apollo](https://github.com/ctripcorp/apollo) 所开发的Golang版本客户端。
15+
A Golang client for the configuration center framework [Apollo](https://github.com/apolloconfig/apollo).
1516

1617
# Features
1718

18-
* 支持多 IP、AppID、namespace
19-
* 实时同步配置
20-
* 灰度配置
21-
* 延迟加载(运行时)namespace
22-
* 客户端,配置文件容灾
23-
* 自定义日志,缓存组件
24-
* 支持配置访问秘钥
19+
* Support for multiple IPs, AppIDs, and namespaces
20+
* Real-time configuration synchronization
21+
* Gray release configuration
22+
* Lazy loading (runtime) namespaces
23+
* Client-side and configuration file fallback
24+
* Customizable logger and cache components
25+
* Support for configuration access keys
2526

2627
# Usage
2728

28-
## 快速入门
29+
## Quick Start
2930

30-
### 导入 agollo
31+
### Import agollo
3132

3233
```
3334
go get -u github.com/apolloconfig/agollo/v4@latest
3435
```
3536

36-
### 启动 agollo
37+
### Initialize agollo
3738

38-
```
39+
```go
3940
package main
4041

4142
import (
4243
"fmt"
44+
4345
"github.com/apolloconfig/agollo/v4"
4446
"github.com/apolloconfig/agollo/v4/env/config"
4547
)
@@ -48,7 +50,7 @@ func main() {
4850
c := &config.AppConfig{
4951
AppID: "testApplication_yang",
5052
Cluster: "dev",
51-
IP: "http://106.54.227.205:8080",
53+
IP: "http://localhost:8080",
5254
NamespaceName: "dubbo",
5355
IsBackupConfig: true,
5456
Secret: "6ce3ff7e96a24335a9634fe9abca6d51",
@@ -57,7 +59,7 @@ func main() {
5759
client, _ := agollo.StartWithConfig(func() (*config.AppConfig, error) {
5860
return c, nil
5961
})
60-
fmt.Println("初始化Apollo配置成功")
62+
fmt.Println("Apollo configuration initialized successfully")
6163

6264
//Use your apollo key to test
6365
cache := client.GetConfigCache(c.NamespaceName)
@@ -66,19 +68,19 @@ func main() {
6668
}
6769
```
6870

69-
## 更多用法
71+
## More Examples
7072

71-
***使用Demo***[agollo_demo](https://github.com/zouyx/agollo_demo)
73+
***Demo Project***: [agollo_demo](https://github.com/zouyx/agollo_demo)
7274

73-
***其他语言*** [agollo-agent](https://github.com/zouyx/agollo-agent.git) 做本地agent接入,如:PHP
75+
***Other Languages:***: Use [agollo-agent](https://github.com/zouyx/agollo-agent.git) as a local agent for languages like PHP.
7476

75-
欢迎查阅 [Wiki](https://github.com/apolloconfig/agollo/wiki) 或者 [godoc](http://godoc.org/github.com/zouyx/agollo) 获取更多有用的信息
77+
Check out our [Wiki](https://github.com/apolloconfig/agollo/wiki) or [godoc](http://godoc.org/github.com/zouyx/agollo) for more information.
7678

77-
如果你觉得该工具还不错或者有问题,一定要让我知道,可以发邮件或者[留言](https://github.com/apolloconfig/agollo/issues)
79+
If you find this tool useful or encounter any issues, please let me know via email or by [creating an issue](https://github.com/apolloconfig/agollo/issues)
7880

7981
# User
8082

81-
* [使用者名单](https://github.com/apolloconfig/agollo/issues/20)
83+
* [User List](https://github.com/apolloconfig/agollo/issues/20)
8284

8385
# Contribution
8486

@@ -91,4 +93,4 @@ The project is licensed under the [Apache 2 license](https://github.com/apolloco
9193

9294
# Reference
9395

94-
Apollo : https://github.com/ctripcorp/apollo
96+
Apollo: [https://github.com/apolloconfig/apollo](https://github.com/apolloconfig/apollo)

README_CN.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
Agollo - Go Client for Apollo
2+
================
3+
中文 | [English](/README.md)
4+
5+
[![golang](https://img.shields.io/badge/Language-Go-green.svg?style=flat)](https://golang.org)
6+
[![Build Status](https://github.com/apolloconfig/agollo/actions/workflows/go.yml/badge.svg)](https://github.com/apolloconfig/agollo/actions/workflows/go.yml)
7+
[![Go Report Card](https://goreportcard.com/badge/github.com/apolloconfig/agollo)](https://goreportcard.com/report/github.com/apolloconfig/agollo)
8+
[![codebeat badge](https://codebeat.co/badges/bc2009d6-84f1-4f11-803e-fc571a12a1c0)](https://codebeat.co/projects/github-com-apolloconfig-agollo-master)
9+
[![Coverage Status](https://coveralls.io/repos/github/apolloconfig/agollo/badge.svg?branch=master)](https://coveralls.io/github/apolloconfig/agollo?branch=master)
10+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
11+
[![GoDoc](http://godoc.org/github.com/apolloconfig/agollo?status.svg)](http://godoc.org/github.com/apolloconfig/agollo)
12+
[![GitHub release](https://img.shields.io/github/release/apolloconfig/agollo.svg)](https://github.com/apolloconfig/apolloconfig/releases)
13+
[![996.icu](https://img.shields.io/badge/link-996.icu-red.svg)](https://996.icu)
14+
15+
方便Golang接入配置中心框架 [Apollo](https://github.com/ctripcorp/apollo) 所开发的Golang版本客户端。
16+
17+
# Features
18+
19+
* 支持多 IP、AppID、namespace
20+
* 实时同步配置
21+
* 灰度配置
22+
* 延迟加载(运行时)namespace
23+
* 客户端,配置文件容灾
24+
* 自定义日志,缓存组件
25+
* 支持配置访问秘钥
26+
27+
# Usage
28+
29+
## 快速入门
30+
31+
### 导入 agollo
32+
33+
```
34+
go get -u github.com/apolloconfig/agollo/v4@latest
35+
```
36+
37+
### 启动 agollo
38+
39+
```
40+
package main
41+
42+
import (
43+
"fmt"
44+
"github.com/apolloconfig/agollo/v4"
45+
"github.com/apolloconfig/agollo/v4/env/config"
46+
)
47+
48+
func main() {
49+
c := &config.AppConfig{
50+
AppID: "testApplication_yang",
51+
Cluster: "dev",
52+
IP: "http://106.54.227.205:8080",
53+
NamespaceName: "dubbo",
54+
IsBackupConfig: true,
55+
Secret: "6ce3ff7e96a24335a9634fe9abca6d51",
56+
}
57+
58+
client, _ := agollo.StartWithConfig(func() (*config.AppConfig, error) {
59+
return c, nil
60+
})
61+
fmt.Println("初始化Apollo配置成功")
62+
63+
//Use your apollo key to test
64+
cache := client.GetConfigCache(c.NamespaceName)
65+
value, _ := cache.Get("key")
66+
fmt.Println(value)
67+
}
68+
```
69+
70+
## 更多用法
71+
72+
***使用Demo***[agollo_demo](https://github.com/zouyx/agollo_demo)
73+
74+
***其他语言***[agollo-agent](https://github.com/zouyx/agollo-agent.git) 做本地agent接入,如:PHP
75+
76+
欢迎查阅 [Wiki](https://github.com/apolloconfig/agollo/wiki) 或者 [godoc](http://godoc.org/github.com/zouyx/agollo) 获取更多有用的信息
77+
78+
如果你觉得该工具还不错或者有问题,一定要让我知道,可以发邮件或者[留言](https://github.com/apolloconfig/agollo/issues)
79+
80+
# User
81+
82+
* [使用者名单](https://github.com/apolloconfig/agollo/issues/20)
83+
84+
# Contribution
85+
86+
* Source Code: https://github.com/apolloconfig/agollo/
87+
* Issue Tracker: https://github.com/apolloconfig/agollo/issues
88+
89+
# License
90+
91+
The project is licensed under the [Apache 2 license](https://github.com/apolloconfig/agollo/blob/master/LICENSE).
92+
93+
# Reference
94+
95+
Apollo: [https://github.com/apolloconfig/apollo](https://github.com/apolloconfig/apollo)

0 commit comments

Comments
 (0)