doc(rust): add badge in README.md (#491)
* doc(rust): add badge in README.md
* doc(all): move most badges to README.md file in each language folder
* doc(all): fix markdown style
* Remove deprecated operating system in GitHub runner
---------
Co-authored-by: Aaron Ai <yangkun.ayk@gmail.com>
diff --git a/.github/workflows/cpp_build.yml b/.github/workflows/cpp_build.yml
index 6115c09..7cd5c9b 100644
--- a/.github/workflows/cpp_build.yml
+++ b/.github/workflows/cpp_build.yml
@@ -7,7 +7,7 @@
runs-on: ${{ matrix.os }}
strategy:
matrix:
- os: [ubuntu-18.04, ubuntu-20.04, ubuntu-22.04, macos-10.15, macos-11, macos-12, windows-2019, windows-2022]
+ os: [ubuntu-20.04, ubuntu-22.04, macos-10.15, macos-11, macos-12, windows-2019, windows-2022]
steps:
- uses: actions/checkout@v2
- name: Compile On Linux
diff --git a/README-CN.md b/README-CN.md
index cc585c1..79c868c 100644
--- a/README-CN.md
+++ b/README-CN.md
@@ -1,14 +1,6 @@
# Apache RocketMQ 客户端
-[![License][license-image]][license-url]
-[![CPP][cpp-image]][cpp-url]
-[![C#][csharp-image]][csharp-url]
-[![Java][java-image]][java-url]
-[![Golang][golang-image]][golang-url]
-[![Codecov-cpp][codecov-cpp-image]][codecov-url]
-[![Codecov-java][codecov-java-image]][codecov-url]
-[![Codecov-golang][codecov-golang-image]][codecov-url]
-[![Maven Central][maven-image]][maven-url]
+[![License][license-image]][license-url] [![CPP][cpp-image]][cpp-url] [![C#][csharp-image]][csharp-url] [![Java][java-image]][java-url] [![Golang][golang-image]][golang-url] [![Rust][rust-image]][rust-url]
[English](README.md) | 简体中文 | [RocketMQ 官网](https://rocketmq.apache.org/)
@@ -27,11 +19,11 @@
| 特性 | Java | C/C++ | C# | Golang | Rust | Node.js | Python |
| ---------------------------------------------- | :---: | :---: | :---: | :----: | :---: | :-----: | :----: |
-| Producer with standard messages | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 | 🚧 |
-| Producer with FIFO messages | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 | 🚧 |
-| Producer with timed/delay messages | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 | 🚧 |
+| Producer with standard messages | ✅ | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 |
+| Producer with FIFO messages | ✅ | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 |
+| Producer with timed/delay messages | ✅ | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 |
| Producer with transactional messages | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 | 🚧 |
-| Simple consumer | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 | 🚧 |
+| Simple consumer | ✅ | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 |
| Push consumer with concurrent message listener | ✅ | ✅ | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 |
| Push consumer with FIFO message listener | ✅ | ✅ | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 |
@@ -68,9 +60,5 @@
[java-url]: https://github.com/apache/rocketmq-clients/actions/workflows/java_build.yml
[golang-image]: https://github.com/apache/rocketmq-clients/actions/workflows/golang_build.yml/badge.svg
[golang-url]: https://github.com/apache/rocketmq-clients/actions/workflows/golang_build.yml
-[codecov-cpp-image]: https://img.shields.io/codecov/c/gh/apache/rocketmq-clients/master?flag=cpp&label=CPP%20Coverage&logo=codecov
-[codecov-java-image]: https://img.shields.io/codecov/c/gh/apache/rocketmq-clients/master?flag=java&label=Java%20Coverage&logo=codecov
-[codecov-golang-image]: https://img.shields.io/codecov/c/gh/apache/rocketmq-clients/master?flag=golang&label=Golang%20Coverage&logo=codecov
-[codecov-url]: https://codecov.io/gh/apache/rocketmq-clients/branch/master/
-[maven-image]: https://maven-badges.herokuapp.com/maven-central/org.apache.rocketmq/rocketmq-client-java/badge.svg
-[maven-url]: https://maven-badges.herokuapp.com/maven-central/org.apache.rocketmq/rocketmq-client-java
+[rust-image]: https://github.com/apache/rocketmq-clients/actions/workflows/rust_build.yml/badge.svg
+[rust-url]: https://github.com/apache/rocketmq-clients/actions/workflows/rust_build.yml
diff --git a/README.md b/README.md
index c534059..1496c35 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,6 @@
# RocketMQ Clients - Collection of Client Bindings for Apache RocketMQ
-[![License][license-image]][license-url]
-[![CPP][cpp-image]][cpp-url]
-[![C#][csharp-image]][csharp-url]
-[![Java][java-image]][java-url]
-[![Golang][golang-image]][golang-url]
-[![Codecov-cpp][codecov-cpp-image]][codecov-url]
-[![Codecov-java][codecov-java-image]][codecov-url]
-[![Codecov-golang][codecov-golang-image]][codecov-url]
-[![Maven Central][maven-image]][maven-url]
-[![NuGet Gallery][nuget-image]][nuget-url]
+[![License][license-image]][license-url] [![CPP][cpp-image]][cpp-url] [![C#][csharp-image]][csharp-url] [![Java][java-image]][java-url] [![Golang][golang-image]][golang-url] [![Rust][rust-image]][rust-url]
English | [简体中文](README-CN.md) | [RocketMQ Website](https://rocketmq.apache.org/)
@@ -28,11 +19,11 @@
| Feature | Java | C/C++ | C# | Golang | Rust | Node.js | Python |
| ---------------------------------------------- | :---: | :---: | :---: | :----: | :---: | :-----: | :----: |
-| Producer with standard messages | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 | 🚧 |
-| Producer with FIFO messages | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 | 🚧 |
-| Producer with timed/delay messages | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 | 🚧 |
+| Producer with standard messages | ✅ | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 |
+| Producer with FIFO messages | ✅ | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 |
+| Producer with timed/delay messages | ✅ | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 |
| Producer with transactional messages | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 | 🚧 |
-| Simple consumer | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 | 🚧 |
+| Simple consumer | ✅ | ✅ | ✅ | ✅ | ✅ | 🚧 | 🚧 |
| Push consumer with concurrent message listener | ✅ | ✅ | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 |
| Push consumer with FIFO message listener | ✅ | ✅ | 🚧 | 🚧 | 🚧 | 🚧 | 🚧 |
@@ -69,11 +60,5 @@
[java-url]: https://github.com/apache/rocketmq-clients/actions/workflows/java_build.yml
[golang-image]: https://github.com/apache/rocketmq-clients/actions/workflows/golang_build.yml/badge.svg
[golang-url]: https://github.com/apache/rocketmq-clients/actions/workflows/golang_build.yml
-[codecov-cpp-image]: https://img.shields.io/codecov/c/gh/apache/rocketmq-clients/master?flag=cpp&label=CPP%20Coverage&logo=codecov
-[codecov-java-image]: https://img.shields.io/codecov/c/gh/apache/rocketmq-clients/master?flag=java&label=Java%20Coverage&logo=codecov
-[codecov-golang-image]: https://img.shields.io/codecov/c/gh/apache/rocketmq-clients/master?flag=golang&label=Golang%20Coverage&logo=codecov
-[codecov-url]: https://codecov.io/gh/apache/rocketmq-clients/branch/master/
-[maven-image]: https://maven-badges.herokuapp.com/maven-central/org.apache.rocketmq/rocketmq-client-java/badge.svg
-[maven-url]: https://maven-badges.herokuapp.com/maven-central/org.apache.rocketmq/rocketmq-client-java
-[nuget-image]: https://img.shields.io/nuget/v/RocketMQ.Client.svg?label=nuget
-[nuget-url]: https://www.nuget.org/packages/RocketMQ.Client/
+[rust-image]: https://github.com/apache/rocketmq-clients/actions/workflows/rust_build.yml/badge.svg
+[rust-url]: https://github.com/apache/rocketmq-clients/actions/workflows/rust_build.yml
diff --git a/cpp/README.md b/cpp/README.md
index 188a809..6f5b2a1 100644
--- a/cpp/README.md
+++ b/cpp/README.md
@@ -1,5 +1,7 @@
# The C++ Implementation of Apache RocketMQ Client
+[![CPP][cpp-image]][cpp-url] [![Codecov-cpp][codecov-cpp-image]][codecov-url]
+
## Introduction
Apache RocketMQ supports two styles of APIs to acknowledge messages once they are successfully processed.
@@ -245,3 +247,8 @@
2. CLion + Bazel Plugin
Bazel also has a plugin for CLion.
+
+[cpp-image]: https://github.com/apache/rocketmq-clients/actions/workflows/cpp_build.yml/badge.svg
+[cpp-url]: https://github.com/apache/rocketmq-clients/actions/workflows/cpp_build.yml
+[codecov-cpp-image]: https://img.shields.io/codecov/c/gh/apache/rocketmq-clients/master?flag=cpp&label=CPP%20Coverage&logo=codecov
+[codecov-url]: https://app.codecov.io/gh/apache/rocketmq-clients
diff --git a/csharp/README-CN.md b/csharp/README-CN.md
index 7f3a343..b6c411f 100644
--- a/csharp/README-CN.md
+++ b/csharp/README-CN.md
@@ -1,5 +1,7 @@
# .NET 客户端
+[![C#][csharp-image]][csharp-url] [![NuGet Gallery][nuget-image]][nuget-url]
+
[English](README.md) | 简体中文 | [RocketMQ 官网](https://rocketmq.apache.org/)
## 最小版本支持
@@ -64,3 +66,8 @@
2. 执行 `dotnet pack --configuration Release` 命令. 这会创建对应的 NuGet 包到 `bin/Release` 文件夹；
3. 登录 NuGet Gallery 并登录，点击 `Upload` 按钮并将 nupkg 文件拖入提示框；
4. 按照 NuGet Gallery 的提示，完成后续步骤。
+
+[csharp-image]: https://github.com/apache/rocketmq-clients/actions/workflows/csharp_build.yml/badge.svg
+[csharp-url]: https://github.com/apache/rocketmq-clients/actions/workflows/csharp_build.yml
+[nuget-image]: https://img.shields.io/nuget/v/RocketMQ.Client.svg?label=nuget
+[nuget-url]: https://www.nuget.org/packages/RocketMQ.Client/
diff --git a/csharp/README.md b/csharp/README.md
index 498a6f2..fb21a9f 100644
--- a/csharp/README.md
+++ b/csharp/README.md
@@ -1,5 +1,7 @@
# The .NET Implementation of Apache RocketMQ Client
+[![C#][csharp-image]][csharp-url] [![NuGet Gallery][nuget-image]][nuget-url]
+
English | [简体中文](https://github.com/apache/rocketmq-clients/blob/master/csharp/README-CN.md)
| [RocketMQ Website](https://rocketmq.apache.org/)
@@ -73,3 +75,8 @@
package file from the `bin/Release` folder.
4. Follow the instructions on the website to complete the upload process. Once the package is uploaded, it will be
available for others to download and use.
+
+[csharp-image]: https://github.com/apache/rocketmq-clients/actions/workflows/csharp_build.yml/badge.svg
+[csharp-url]: https://github.com/apache/rocketmq-clients/actions/workflows/csharp_build.yml
+[nuget-image]: https://img.shields.io/nuget/v/RocketMQ.Client.svg?label=nuget
+[nuget-url]: https://www.nuget.org/packages/RocketMQ.Client/
diff --git a/golang/README.md b/golang/README.md
index 9e0c28b..32c6073 100644
--- a/golang/README.md
+++ b/golang/README.md
@@ -1,5 +1,7 @@
# The Golang Implementation of Apache RocketMQ Client
+[![Golang][golang-image]][golang-url] [![Codecov-golang][codecov-golang-image]][codecov-url]
+
Here is the golang implementation of the client for [Apache RocketMQ](https://rocketmq.apache.org/).
## Architecture
@@ -21,3 +23,8 @@
```sh
go get -u github.com/apache/rocketmq-clients/golang/v5
```
+
+[golang-image]: https://github.com/apache/rocketmq-clients/actions/workflows/golang_build.yml/badge.svg
+[golang-url]: https://github.com/apache/rocketmq-clients/actions/workflows/golang_build.yml
+[codecov-golang-image]: https://img.shields.io/codecov/c/gh/apache/rocketmq-clients/master?flag=golang&label=Golang%20Coverage&logo=codecov
+[codecov-url]: https://app.codecov.io/gh/apache/rocketmq-clients
diff --git a/java/README-CN.md b/java/README-CN.md
index d80e615..8fa202a 100644
--- a/java/README-CN.md
+++ b/java/README-CN.md
@@ -1,5 +1,7 @@
# Java 客户端
+[![Java][java-image]][java-url] [![Codecov-java][codecov-java-image]][codecov-url] [![Maven Central][maven-image]][maven-url]
+
[English](README.md) | 简体中文 | [RocketMQ 官网](https://rocketmq.apache.org/)
## 概述
@@ -70,3 +72,10 @@
* `rocketmq.log.file.maxIndex`: 日志文件最大保留个数，默认为 10（单个日志文件大小限制为 64 MB，暂不支持调整）。
特别地，如果有调试的需求，可以通过把 `mq.consoleAppender.enabled` 设置成 `true` 将客户端的日志同时输出到控制台。
+
+[java-image]: https://github.com/apache/rocketmq-clients/actions/workflows/java_build.yml/badge.svg
+[java-url]: https://github.com/apache/rocketmq-clients/actions/workflows/java_build.yml
+[codecov-java-image]: https://img.shields.io/codecov/c/gh/apache/rocketmq-clients/master?flag=java&label=Java%20Coverage&logo=codecov
+[codecov-url]: https://app.codecov.io/gh/apache/rocketmq-clients
+[maven-image]: https://img.shields.io/maven-central/v/org.apache.rocketmq/rocketmq-client-java
+[maven-url]: https://maven-badges.herokuapp.com/maven-central/org.apache.rocketmq/rocketmq-client-java
diff --git a/java/README.md b/java/README.md
index b376136..c81c2e2 100644
--- a/java/README.md
+++ b/java/README.md
@@ -1,5 +1,7 @@
# The Java Implementation of Apache RocketMQ Client
+[![Java][java-image]][java-url] [![Codecov-java][codecov-java-image]][codecov-url] [![Maven Central][maven-image]][maven-url]
+
English | [简体中文](README-CN.md) | [RocketMQ Website](https://rocketmq.apache.org/)
## Overview
@@ -68,3 +70,10 @@
* `rocketmq.log.file.maxIndex`: the maximum number of log files to keep, default is 10 (the size of a single log file is limited to 64 MB, no adjustment is supported now).
Specifically, by setting `mq.consoleAppender.enabled` to true, you can output client logs to the console simultaneously if you need debugging.
+
+[java-image]: https://github.com/apache/rocketmq-clients/actions/workflows/java_build.yml/badge.svg
+[java-url]: https://github.com/apache/rocketmq-clients/actions/workflows/java_build.yml
+[codecov-java-image]: https://img.shields.io/codecov/c/gh/apache/rocketmq-clients/master?flag=java&label=Java%20Coverage&logo=codecov
+[codecov-url]: https://app.codecov.io/gh/apache/rocketmq-clients
+[maven-image]: https://img.shields.io/maven-central/v/org.apache.rocketmq/rocketmq-client-java
+[maven-url]: https://maven-badges.herokuapp.com/maven-central/org.apache.rocketmq/rocketmq-client-java
diff --git a/rust/README.md b/rust/README.md
index 0181494..2a2e696 100644
--- a/rust/README.md
+++ b/rust/README.md
@@ -1,5 +1,10 @@
# The Rust Implementation of Apache RocketMQ Client
+[![Rust][rust-image]][rust-url]
+[![Codecov-rust][codecov-rust-image]][codecov-url]
+[![Crates.io][crates-image]][crates-url]
+[![docs.rs][rust-doc-image]][rust-doc-url]
+
[RocketMQ Website](https://rocketmq.apache.org/)
## Overview
@@ -33,3 +38,12 @@
# consume message via simple consumer
cargo run --example simple_consumer
```
+
+[rust-image]: https://github.com/apache/rocketmq-clients/actions/workflows/rust_build.yml/badge.svg
+[rust-url]: https://github.com/apache/rocketmq-clients/actions/workflows/rust_build.yml
+[codecov-rust-image]: https://img.shields.io/codecov/c/gh/apache/rocketmq-clients/master?flag=rust&label=Rust%20Coverage&logo=codecov
+[codecov-url]: https://app.codecov.io/gh/apache/rocketmq-clients
+[crates-image]: https://img.shields.io/crates/v/rocketmq.svg
+[crates-url]: https://crates.io/crates/rocketmq
+[rust-doc-image]: https://docs.rs/rocketmq/badge.svg
+[rust-doc-url]: https://img.shields.io/crates/v/rocketmq.svg
