Docs: optimize README (#260)

b4c80b06 · yeka · GitHub · 8378ed6a · b4c80b06 · b4c80b06
Unverified Commit b4c80b06 authored 3 years ago by yeka Committed by GitHub 3 years ago
Hide whitespace changes
Inline Side-by-side

Showing

with 15 additions and 3 deletions
+15 -3
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
 # Contribution guidelines

-So you want to hack on Loggie? Please refer to Loggie`s
- [contribution guidelines](https://loggie-io.github.io/docs/developer-guide/contributing/).
\ No newline at end of file
+So you want to contribute to Loggie? Please refer to Loggie's
+ [contribution guidelines](https://loggie-io.github.io/docs/developer-guide/contributing/).
--- a/README.md
+++ b/README.md
@@ -3,6 +3,7 @@

 [![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://loggie-io.github.io/docs/)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/569/badge)](https://bestpractices.coreinfrastructure.org/projects/569)
+[![dockerHub](https://img.shields.io/badge/dockerHub-loggieio%2Floggie-9cf)](https://hub.docker.com/r/loggieio/loggie/)

 > English | [中文](./README_cn.md)

@@ -44,3 +45,8 @@ Loggie is a lightweight, high-performance, cloud-native agent and aggregator bas

 [Apache-2.0](https://choosealicense.com/licenses/apache-2.0/)

+## Contributions
+
+Pull requests, comments and suggestions are welcome.
+
+Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
--- a/README_cn.md
+++ b/README_cn.md

 <img src="https://github.com/loggie-io/loggie/blob/main/logo/loggie.svg" width="250">

-[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://loggie-io.github.io/docs/) 
+[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white)](https://loggie-io.github.io/docs/)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/569/badge)](https://bestpractices.coreinfrastructure.org/projects/569)
+[![dockerHub](https://img.shields.io/badge/dockerHub-loggieio%2Floggie-9cf)](https://hub.docker.com/r/loggieio/loggie/)

 Loggie是一个基于Golang的轻量级、高性能、云原生日志采集Agent和中转处理Aggregator，支持多Pipeline和组件热插拔，提供了：

@@ -50,3 +51,8 @@ Loggie是一个基于Golang的轻量级、高性能、云原生日志采集Agent

 [Apache-2.0](https://choosealicense.com/licenses/apache-2.0/)

+## 贡献
+
+欢迎提交代码、发表评论和建议。
+
+查看 [CONTRIBUTING.md](CONTRIBUTING.md) 获得更多信息。