Update README for cncf project and add chinese README

Signed-off-by: Lan Liang <[email protected]>
openelb · Feb 20, 2022 · 50fb68f · 50fb68f
1 parent be0ef50
commit 50fb68f
Show file tree

Hide file tree

Showing 2 changed files with 54 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,8 @@
 
 ![OpenELB Logo](./doc/logo/color-horizontal.svg)
 
-OpenELB is an open-source load balancer implementation designed for exposing the LoadBalancer type of Kubernetes services in bare metal, edge, and virtualization environments.
+[中文](README_zh.md)
+OpenELB is an open-source load balancer implementation designed for exposing the LoadBalancer type of Kubernetes services in bare metal, edge, and virtualization environments.Hosted by [CNCF](https://www.cncf.io/) as a [Sandbox Project](https://www.cncf.io/sandbox-projects/)
 
 ## Why OpenELB
 
@@ -20,13 +21,13 @@ In cloud-based Kubernetes clusters, Services are usually exposed by using load b
 
 ## Quickstart
 
-- [Install OpenELB on Kubernetes](https://porterlb.io/docs/getting-started/installation/install-porter-on-kubernetes/)
-- [Install OpenELB on K3s](https://porterlb.io/docs/getting-started/installation/install-porter-on-k3s/)
-- [Install OpenELB on KubeSphere](https://porterlb.io/docs/getting-started/installation/install-porter-on-kubesphere/)
+- [Install OpenELB on Kubernetes](https://openelb.github.io/docs/getting-started/installation/install-porter-on-kubernetes/)
+- [Install OpenELB on K3s](https://openelb.github.io/docs/getting-started/installation/install-porter-on-k3s/)
+- [Install OpenELB on KubeSphere](https://openelb.github.io/docs/getting-started/installation/install-porter-on-kubesphere/)
 
 ## Documentation
 
-You can learn how to use OpenELB in a cloud-based Kubernetes cluster by following the [OpenELB Documentation](https://porterlb.io/docs/).
+You can learn how to use OpenELB in a cloud-based Kubernetes cluster by following the [OpenELB Documentation](https://openelb.github.io/docs/).
 
 ## Adopters
 
@@ -38,21 +39,8 @@ OpenELB has been adopted by [many companies](./ADOPTERS.md) all over the world.
 
 ## Support, Discussion and Contributing
 
-OpenELB is a sub-project of [KubeSphere](https://github.com/kubesphere/kubesphere).
-
-* Join us at the [KubeSphere Slack Channel](https://kubesphere.slack.com/join/shared_invite/enQtNTE3MDIxNzUxNzQ0LTZkNTdkYWNiYTVkMTM5ZThhODY1MjAyZmVlYWEwZmQ3ODQ1NmM1MGVkNWEzZTRhNzk0MzM5MmY4NDc3ZWVhMjE#/) to get support or simply tell us that you are using OpenELB.
-* You have code or documents for OpenELB? Contributions are always welcome! See [Building and Contributing](https://porterlb.io/docs/building-and-contributing/) to obtain guidance.
-
-## Landscapes
-
-<p align="center">
-<br/><br/>
-<img src="https://landscape.cncf.io/images/left-logo.svg" width="150"/>&nbsp;&nbsp;<img src="https://landscape.cncf.io/images/right-logo.svg" width="200"/>&nbsp;&nbsp;
-<br/><br/>
-OpenELB is a promising newcomer in Service proxy, which enriches the <a href="https://landscape.cncf.io/landscape=observability-and-analysis&license=apache-license-2-0">CNCF CLOUD NATIVE Landscape.
-</a>
-</p>
-
+* Join us at the [KubeSphere Slack Channel](https://kubesphere.slack.com/join/shared_invite/enQtNTE3MDIxNzUxNzQ0LTZkNTdkYWNiYTVkMTM5ZThhODY1MjAyZmVlYWEwZmQ3ODQ1NmM1MGVkNWEzZTRhNzk0MzM5MmY4NDc3ZWVhMjE#/) to get support or simply tell us that you are using OpenELB.(openelb slack channel from kubernetes will be soon)
+* You have code or documents for OpenELB? Contributions are always welcome! See [Building and Contributing](https://openelb.github.io/docs/building-and-contributing/) to obtain guidance.
 
 ## License
 

diff --git a/README_zh.md b/README_zh.md
@@ -0,0 +1,46 @@
+# OpenELB 
+
+![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/kubesphere/openelb) ![go report](https://goreportcard.com/badge/github.com/kubesphere/openelb)
+
+![OpenELB Logo](./doc/logo/color-horizontal.svg)
+
+OpenELB是一个开源的负载均衡器实现,可以在裸金属服务器、边缘以及虚拟化环境中使用LoadBalancer类型的service.目前作为[沙箱项目](https://www.cncf.io/sandbox-projects/)托管于[CNCF](https://www.cncf.io/).
+
+## 为什么选择OpenELB
+
+在云服务环境中的kubernetes集群里,通常可以用云服务提供商提供的负载均衡服务来暴露service,但是在本地没办法这样操作.而OpenELB可以让用户在裸金属服务器、边缘以及虚拟化环境中创建LoadBalancer类型的service来暴露服务,并且可以做到和云环境中的用户体验是一致的.
+
+## 核心功能
+
+- BGP模式和二层网络模式下的负载均衡
+- ECMP路由和负载均衡
+- IP池管理
+- 基于CRD来管理BGP配置
+- 支持Helm Chart方式安装
+
+## 快速入门
+
+- [在Kubernetes中安装OpenELB](https://openelb.github.io/docs/getting-started/installation/install-porter-on-kubernetes/)
+- [在K3s中安装OpenELB](https://openelb.github.io/docs/getting-started/installation/install-porter-on-k3s/)
+- [在KubeSphere中安装OpenELB](https://openelb.github.io/docs/getting-started/installation/install-porter-on-kubesphere/)
+
+## 文档
+
+你可以按照[OpenELB文档](https://openelb.github.io/docs/)中的步骤来学习如何在云服务K8S中部署OpenELB.
+
+## 采用者
+
+OpenELB已经被采用在[很多公司](./ADOPTERS.md),如果你也正在使用OpenELB,欢迎加入到用户社区并且把你的logo添加到[采用者列表](./ADOPTERS.md)!
+
+## 开发计划
+
+[OpenELB开发计划](doc/roadmap.md)列出了每个里程碑下的功能以及bug修复,如果你有新的想法、功能需求或者建议,欢迎提交proposal.
+
+## 参与贡献以及讨论
+
+* 加入[KubeSphere Slack Channel](https://kubesphere.slack.com/join/shared_invite/enQtNTE3MDIxNzUxNzQ0LTZkNTdkYWNiYTVkMTM5ZThhODY1MjAyZmVlYWEwZmQ3ODQ1NmM1MGVkNWEzZTRhNzk0MzM5MmY4NDc3ZWVhMjE#/)来咨询问题或告诉我们你正在使用OpenELB.(很快将会有kubernetes下的slack channel)
+* 欢迎任何文档完善以及代码贡献!具体可以看[贡献指南](https://openelb.github.io/docs/building-and-contributing/).
+
+## License
+
+OpenELB is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full license text.