This is an automated email from the ASF dual-hosted git repository.
albumenj pushed a commit to branch 3.3
in repository https://gitbox.apache.org/repos/asf/dubbo.git
The following commit(s) were added to refs/heads/3.3 by this push:
new 379fa907b7 Readme Update (#15394)
379fa907b7 is described below
commit 379fa907b787987586e19d18db8dc1ee9b75c48e
Author: Akshat Sharma <[email protected]>
AuthorDate: Mon May 19 07:37:05 2025 +0530
Readme Update (#15394)
* Improved and Better README.md file
* Testing Some other README.md version
* Final change for README.md better and concise
---
README.md | 181 ++++++++++++++++++++++++++++++++------------------------------
1 file changed, 93 insertions(+), 88 deletions(-)
diff --git a/README.md b/README.md
index 38c8ec8163..56f43e9a67 100644
--- a/README.md
+++ b/README.md
@@ -1,133 +1,138 @@
+
# Apache Dubbo Project
[](https://github.com/apache/dubbo/actions/workflows/build-and-test-pr.yml)
[](https://codecov.io/gh/apache/dubbo)
[](https://github.com/apache/dubbo/releases)
[](https://github.com/apache/dubbo/blob/3.3/LICENSE)
-[](http://isitmaintained.com/project/apache/dubbo
"Average time to resolve an issue")
-[](http://isitmaintained.com/project/apache/dubbo
"Percentage of issues still open")
+[](http://isitmaintained.com/project/apache/dubbo)
+[](http://isitmaintained.com/project/apache/dubbo)
+
+Apache Dubbo is a powerful and user-friendly Web and RPC framework. It
supports multiple language implementations such as Java,
[Go](https://github.com/apache/dubbo-go),
[Python](https://github.com/dubbo/py-client-for-apache-dubbo),
[PHP](https://github.com/apache/dubbo-php-framework),
[Erlang](https://github.com/apache/dubbo-erlang),
[Rust](https://github.com/apache/dubbo-rust), and
[Node.js/Web](https://github.com/apache/dubbo-js).
+
+Dubbo provides solutions for communication, service discovery, traffic
management, observability, security, tooling, and best practices for building
enterprise-grade microservices.
-Apache Dubbo is an easy-to-use Web and RPC framework that provides multiple
-language implementations(Java, [Go](https://github.com/apache/dubbo-go),
[Python](https://github.com/dubbo/py-client-for-apache-dubbo),
[PHP](https://github.com/apache/dubbo-php-framework),
[Erlang](https://github.com/apache/dubbo-erlang),
[Rust](https://github.com/apache/dubbo-rust),
[Node.js](https://github.com/apache/dubbo-js),
[Web](https://github.com/apache/dubbo-js)) for communication, service
discovery, traffic management,
-observability, security, tools, and best practices for building
enterprise-ready microservices.
+> 🚀 We're collecting user info to improve Dubbo. Help us out here: [Who's
using Dubbo](https://github.com/apache/dubbo/discussions/13842)
-We are now collecting Dubbo user info to help us to improve Dubbo further.
Kindly support us by providing your usage information on [Wanted: who's using
dubbo](https://github.com/apache/dubbo/discussions/13842), thanks :)
+---
+
+## 🧱 Architecture
-## Architecture
-* Consumer and provider communicate with each other using RPC protocol like
triple, tcp, rest, etc.
-* Consumers automatically trace provider instances registered in
registries(Zookeeper, Nacos) and distribute traffic among them by following
traffic strategies.
-* Rich features for monitoring and managing the cluster with dynamic
configuration, metrics, tracing, security, and visualized console.
+- Communication between consumers and providers is done via RPC protocols like
Triple, TCP, REST, etc.
+- Consumers dynamically discover provider instances from registries (e.g.,
Zookeeper, Nacos) and manage traffic using defined strategies.
+- Built-in support for dynamic config, metrics, tracing, security, and a
visualized console.
+
+---
+
+## 🚀 Getting Started
+
+### 📦 Lightweight RPC API
+
+Start quickly with our [5-minute
guide](https://cn.dubbo.apache.org/zh-cn/overview/mannual/java-sdk/tasks/framework/lightweight-rpc/)
+
+Dubbo allows you to build RPC services using a minimal codebase and a
lightweight SDK. It supports protocols like:
+
+- [Triple
(gRPC-compatible)](https://dubbo.apache.org/zh-cn/overview/reference/protocols/triple/)
+- Dubbo2 (TCP)
+- REST
+- Custom protocols
+
+### 🌱 Microservices with Spring Boot
-## Getting started
-Follow the instructions below to learn how to:
+Kickstart your project using [Spring Boot
Starter](https://cn.dubbo.apache.org/zh-cn/overview/mannual/java-sdk/tasks/develop/springboot/).
-### Programming with lightweight RPC API
-[5 minutes step-by-step
guide](https://cn.dubbo.apache.org/zh-cn/overview/mannual/java-sdk/tasks/framework/lightweight-rpc/)
+Using just a dependency and a YAML config, you can unlock the full power of
Dubbo: service discovery, observability, tracing, etc.
-Dubbo supports building RPC services with only a few lines of code while
depending only on a lightweight SDK. The protocol on the wire can be
[Triple](https://dubbo.apache.org/zh-cn/overview/reference/protocols/triple/)(fully
gRPC compatible and HTTP-friendly), Dubbo2(TCP), REST, or any protocol of your
choice.
+➡️ Learn how to
[deploy](https://dubbo.apache.org/zh-cn/overview/tasks/deploy/),
[monitor](https://dubbo.apache.org/zh-cn/overview/tasks/observability/), and
[manage
traffic](https://dubbo.apache.org/zh-cn/overview/tasks/traffic-management/) for
Dubbo services.
+---
-### Building a microservice application with Spring Boot
-[5 minutes step-by-step
guide](https://cn.dubbo.apache.org/zh-cn/overview/mannual/java-sdk/tasks/develop/springboot/)
+## 🛠️ More Features
-It's highly recommended to start your microservice application with the Spring
Boot Starter `dubbo-spring-boot-starter` provided by Dubbo. With only a single
dependency and yaml file, and optionally a bunch of other useful spring boot
starters, you can enable all of the Dubo features like service discovery,
observability, tracing, etc.
+Explore more through our hands-on tasks:
-Next, learn how to
[deploy](https://dubbo.apache.org/zh-cn/overview/tasks/deploy/),
[monitor](https://dubbo.apache.org/zh-cn/overview/tasks/observability/), and
[manage the
traffic](https://dubbo.apache.org/zh-cn/overview/tasks/traffic-management/) of
your Dubbo application and cluster.
+- [Launch a Dubbo
project](https://dubbo.apache.org/zh-cn/overview/tasks/develop/template/)
+- [RPC
protocols](https://dubbo.apache.org/zh-cn/overview/core-features/protocols/)
+- [Traffic
management](https://dubbo.apache.org/zh-cn/overview/core-features/traffic/)
+- [Service
discovery](https://dubbo.apache.org/zh-cn/overview/core-features/service-discovery/)
+-
[Observability](https://dubbo.apache.org/zh-cn/overview/core-features/observability/)
+-
[Extensibility](https://dubbo.apache.org/zh-cn/overview/core-features/extensibility/)
+- [Security](https://dubbo.apache.org/zh-cn/overview/core-features/security/)
+- [Visualized
Console](https://dubbo.apache.org/zh-cn/overview/reference/admin/)
+- [Kubernetes & Service
Mesh](https://dubbo.apache.org/zh-cn/overview/core-features/service-mesh/)
-## More Features
-Get more details by visiting the links below to get your hands dirty with some
well-designed tasks on our website.
+---
-* [Launch a Dubbo
project](https://dubbo.apache.org/zh-cn/overview/tasks/develop/template/)
-* [RPC
protocols](https://dubbo.apache.org/zh-cn/overview/core-features/protocols/)
-* [Traffic
management](https://dubbo.apache.org/zh-cn/overview/core-features/traffic/)
-* [Service
discovery](https://dubbo.apache.org/zh-cn/overview/core-features/service-discovery/)
-*
[Observability](https://dubbo.apache.org/zh-cn/overview/core-features/observability/)
-*
[Extensibility](https://dubbo.apache.org/zh-cn/overview/core-features/extensibility/)
-* [Security](https://dubbo.apache.org/zh-cn/overview/core-features/security/)
-* [Visualized console and control
plane](https://dubbo.apache.org/zh-cn/overview/reference/admin/)
-* [Kubernetes and Service
mesh](https://dubbo.apache.org/zh-cn/overview/core-features/service-mesh/)
+## 📦 Which Dubbo Version Should I Use?
-## Which Dubbo version should I use?
-| **Dubbo3** | **JDK** | **Dependencies**
| **Description**
|
-|------------|----------|---------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| 3.3.2 | 1.8 ～ 21 | [dependency
list](https://github.com/apache/dubbo/blob/dubbo-3.3.2/dubbo-dependencies-bom/pom.xml#L92)
| **- Stable version (active)** <br/> **- Features** <br/> -
Triple - gRPC and cURL compatible.<br/> - Rest-style programming
support.<br/> - Spring Boot Starters. |
-| 3.2.16 | 1.8 ～ 17 | [dependency
list](https://github.com/apache/dubbo/blob/dubbo-3.2.5/dubbo-dependencies-bom/pom.xml#L94)
| **- Stable version (active)** <br/> **- Features** <br/> -
Out-of-box metrics and tracing support.<br/> - Threadpool
Isolation<br/> - 30% performance<br/> - Native Image |
-| 3.1.11 | 1.8 ～ 17 | [dependency
list](https://github.com/apache/dubbo/blob/dubbo-3.2.11/dubbo-dependencies-bom/pom.xml#L90)
| **Stable version (not active)**
|
+### Dubbo3
-| **Dubbo2** | **JDK** | **Dependencies**
| **Description** |
-| --- | ---
|---------------------------------------------------------------------------------------------------------|
--- |
-| 2.7.23 | 1.8 | [dependency
list](https://github.com/apache/dubbo/blob/dubbo-2.7.23/dubbo-dependencies-bom/pom.xml#L92)
| EOL |
-| 2.6.x, 2.5.x | 1.6 ～ 1.7 | [dependency
list](https://github.com/apache/dubbo/blob/dubbo-2.6.12/dependencies-bom/pom.xml#L90)
| EOL |
+## 📦 Version Compatibility
-## Contributing
-See
[CONTRIBUTING](https://github.com/apache/dubbo/blob/master/CONTRIBUTING.md) for
details on submitting patches and the contribution workflow.
+| Version | JDK Support | Dependencies
| Highlights
|
+|----------|-------------|--------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|
+| **3.3.2** | 1.8 – 21 | [View
Dependencies](https://github.com/apache/dubbo/blob/dubbo-3.3.2/dubbo-dependencies-bom/pom.xml#L92)
| ✅ Actively Maintained <br> ✅ Triple Protocol (gRPC/cURL) <br> ✅ REST Support
<br> ✅ Spring Boot Starters |
+| **3.2.16** | 1.8 – 17 | [View
Dependencies](https://github.com/apache/dubbo/blob/dubbo-3.2.5/dubbo-dependencies-bom/pom.xml#L94)
| ✅ Actively Maintained <br> ✅ Metrics & Tracing <br> ✅ Thread Pool Isolation
<br> ✅ +30% Performance <br> ✅ Native Image Support |
+| **3.1.11** | 1.8 – 17 | [View
Dependencies](https://github.com/apache/dubbo/blob/dubbo-3.2.11/dubbo-dependencies-bom/pom.xml#L90)
| ⚠️ Stable, but Not Actively Maintained
|
-### How does the Dubbo Community collaborate?
+### Dubbo2
-The Dubbo Community primarily communicates on GitHub through issues,
discussions, and pull requests.
+| Version | JDK | Dependencies
| Description |
+|-------------|-----------|--------------------------------------------------------------------------------------------------------|-------------|
+| 2.7.23 | 1.8 | [dependency
list](https://github.com/apache/dubbo/blob/dubbo-2.7.23/dubbo-dependencies-bom/pom.xml#L92)
| ❌ EOL |
+| 2.6.x, 2.5.x| 1.6 - 1.7 | [dependency
list](https://github.com/apache/dubbo/blob/dubbo-2.6.12/dependencies-bom/pom.xml#L90)
| ❌ EOL |
-- Issues: We use issues to track bugs and tasks. Any **work-related** item is
associated with an issue.
-- Discussions: We use discussions for questions, early proposals, and
announcements. Any **idea-related** item is associated with a discussion.
-- Pull Requests: We use pull requests to merge a set of changes from
contributors into Dubbo.
+---
-We have also implemented [a project
board](https://github.com/orgs/apache/projects/337) to monitor all the items.
+## 🤝 Contributing
-Any essential changes should be discussed on the mailing list before they
happen.
+See our
[CONTRIBUTING](https://github.com/apache/dubbo/blob/master/CONTRIBUTING.md)
guide to get started!
-### Seeking help
+### 🔁 Community Collaboration
-If you have questions such as:
+- **Issues**: For bugs or tasks – [GitHub
Issues](https://github.com/apache/dubbo/issues)
+- **Discussions**: For questions, ideas – [GitHub
Discussions](https://github.com/apache/dubbo/discussions)
+- **PRs**: For merging your contributions – [GitHub Pull
Requests](https://github.com/apache/dubbo/pulls)
+- **Project Board**: [Dubbo Project
Board](https://github.com/orgs/apache/projects/337)
-- What is Dubbo?
-- How do I use Dubbo?
-- Why did an unexpected result occur?
+### 💡 How You Can Help
-Please start a discussion at https://github.com/apache/dubbo/discussions.
+- Check out "help wanted" issues: [Project
Board](https://github.com/orgs/apache/projects/337)
+- Join [mailing list
discussions](https://github.com/apache/dubbo/wiki/Mailing-list-subscription-guide)
+- Engage in [discussions](https://github.com/apache/dubbo/discussions)
+- Fix [bugs](https://github.com/apache/dubbo/issues) or review [pull
requests](https://github.com/apache/dubbo/pulls)
+- Enhance the [website](https://github.com/apache/dubbo-website)
+- Improve [dubbo-admin](https://github.com/apache/dubbo-admin)
+- Contribute to the
[ecosystem](https://github.com/apache/?q=dubbo&type=all&language=&sort=)
-However, if you encounter the following situations:
+If you're interested in contributing, email us at
[[email protected]](mailto:[email protected]).
-- You're certain there's a bug that Dubbo needs to fix,
-- You believe a feature could be enhanced,
-- You have a detailed proposal for improving Dubbo,
+---
-Please open an issue at https://github.com/apache/dubbo/issues.
+## 🐞 Reporting Issues
-To ask effective questions, we recommend reading **[How To Ask Questions The
Smart
Way](https://github.com/selfteaching/How-To-Ask-Questions-The-Smart-Way/blob/master/How-To-Ask-Questions-The-Smart-Way.md)**
first.
+Please use our [issue
template](https://github.com/apache/dubbo/issues/new?template=dubbo-issue-report-template.md)
when reporting bugs.
-### Make a Contribution
+---
-- Browse the "help wanted" tasks in the [Dubbo project
board](https://github.com/orgs/apache/projects/337).
-- Participate in discussions on the mailing list. See the subscription
[guide](https://github.com/apache/dubbo/wiki/Mailing-list-subscription-guide).
-- Respond to queries in the
[discussions](https://github.com/apache/dubbo/issues).
-- Resolve bugs reported in [issues](https://github.com/apache/dubbo/issues)
and send us a pull request.
-- Review existing [pull requests](https://github.com/apache/dubbo/pulls).
-- Enhance the [website](https://github.com/apache/dubbo-website). We typically
need:
- - Blog posts
- - Translations for documentation
- - Use cases showcasing Dubbo integration in enterprise systems.
-- Improve the [dubbo-admin](https://github.com/apache/dubbo-admin).
-- Contribute to the projects listed in the
[ecosystem](https://github.com/apache/?q=dubbo&type=all&language=&sort=).
-- Any other forms of contribution not listed above are also welcome.
-- If you're interested in contributing, please send an email to
[[email protected]](mailto:[email protected]) to let us know!
+## 🔐 Reporting Security Vulnerabilities
-For more details, please take a look at our
[guide](https://github.com/apache/dubbo/blob/master/CONTRIBUTING.md) about how
to contribute to Dubbo.
+Please report vulnerabilities **privately** to
[[email protected]](mailto:[email protected]).
-## Reporting bugs
+---
-Please follow the
[template](https://github.com/apache/dubbo/issues/new?template=dubbo-issue-report-template.md)
for reporting any issues.
+## 📬 Contact
-## Reporting a security vulnerability
+- **WeChat**: `apachedubbo`
+- **DingTalk**: Group ID `37290003945`
+- **Mailing List**: [Contact Guide](https://dubbo.apache.org/zh-cn/contact/)
+- **Twitter**: [@ApacheDubbo](https://twitter.com/ApacheDubbo)
+- **Security**: [[email protected]](mailto:[email protected])
-Please report security vulnerabilities to
[us](mailto:[email protected]) privately.
+---
-## Contact
-* WeChat: apachedubbo
-* DingTalk group: 37290003945
-* Mailing list: [guide](https://dubbo.apache.org/zh-cn/contact/)
-* Twitter: [@ApacheDubbo](https://twitter.com/ApacheDubbo)
-* Security issues: please mail to [us](mailto:[email protected])
privately.
+## 📄 License
-## License
-Apache Dubbo is licensed under the Apache License Version 2.0. See the
[LICENSE](https://github.com/apache/dubbo/blob/3.3/LICENSE) file for details.
+Apache Dubbo is licensed under the [Apache License
2.0](https://github.com/apache/dubbo/blob/3.3/LICENSE).
