Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 upgrade readme #235

Merged
merged 2 commits into from
Nov 10, 2023
Merged

📝 upgrade readme #235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fe5a63
:memo: upgrade readme
songxiaosheng Nov 9, 2023
dd9868e
:memo: upgrade readme
songxiaosheng Nov 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
[![codecov](https://codecov.io/gh/apache/dubbo-spi-extensions/branch/master/graph/badge.svg)](https://codecov.io/gh/apache/dubbo-spi-extensions)
[![Maven Central](https://img.shields.io/maven-central/v/org.apache.dubbo/dubbo-spi-extensions.svg)](https://search.maven.org/search?q=g:org.apache.dubbo%20AND%20a:dubbo-spi-extensions)
[![GitHub release](https://img.shields.io/github/release/apache/dubbo-spi-extensions.svg)]

The purpose of dubbo-spi-extensions is to provide open, community-driven, reusable components to build microservice programs with different needs. These components extend the core of the Apache Dubbo project, but they are separated and decoupled.

Developers can flexibly choose the required extension dependencies to develop microservice programs based on their needs. The available extensions are as follows:Developers can flexibly choose the required extension dependencies to develop microservice programs based on their needs.

The available extensions are as follows:

- [dubbo-api-docs](dubbo-api-docs)
- [dubbo-api-docs-annotations](dubbo-api-docs/dubbo-api-docs-annotations)
- [dubbo-api-docs-core](dubbo-api-docs/dubbo-api-docs-core)
Expand Down Expand Up @@ -66,7 +73,9 @@
- [dubbo-serialization-avro](dubbo-serialization-extensions/dubbo-serialization-avro)
- [dubbo-serialization-fastjson](dubbo-serialization-extensions/dubbo-serialization-fastjson)
- [dubbo-serialization-fst](dubbo-serialization-extensions/dubbo-serialization-fst)
- [dubbo-serialization-fury](dubbo-serialization-extensions/dubbo-serialization-fury)
- [dubbo-serialization-gson](dubbo-serialization-extensions/dubbo-serialization-gson)
- [dubbo-serialization-jackson](dubbo-serialization-extensions/dubbo-serialization-jackson)
- [dubbo-serialization-kryo](dubbo-serialization-extensions/dubbo-serialization-kryo)
- [dubbo-serialization-msgpack](dubbo-serialization-extensions/dubbo-serialization-msgpack)
- [dubbo-serialization-native-hession](dubbo-serialization-extensions/dubbo-serialization-native-hession)
Expand All @@ -75,3 +84,15 @@
- [dubbo-serialization-test](dubbo-serialization-extensions/dubbo-serialization-test)
- [dubbo-tag-extensions](dubbo-tag-extensions)
- [dubbo-tag-subnets](dubbo-tag-extensions/dubbo-tag-subnets)

## Contribution


Thanks to everyone who has contributed!


<a href="https://github.com/apache/dubbo-spi-extensions/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=apache/dubbo-spi-extensions" />
</a>


35 changes: 31 additions & 4 deletions dobbo-doc-auto-gen/src/main/java/org/apache/dubbo/doc/DocAutoGen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,39 @@ public static void main(String[] args) throws IOException {
int level = 0;
String parentPath = "";
System.setOut(new PrintStream(filePath + "/" + "README.md"));
System.out.println("# dubbo-spi-extensions");
System.out.println("[![Build Status](https://travis-ci.org/apache/dubbo-spi-extensions.svg?branch=master)](https://travis-ci.org/apache/dubbo-spi-extensions)\n" +
String title = "# dubbo-spi-extensions";
System.out.println(title);
String x = "[![Build Status](https://travis-ci.org/apache/dubbo-spi-extensions.svg?branch=master)](https://travis-ci.org/apache/dubbo-spi-extensions)\n" +
"[![codecov](https://codecov.io/gh/apache/dubbo-spi-extensions/branch/master/graph/badge.svg)](https://codecov.io/gh/apache/dubbo-spi-extensions)\n" +
"[![Maven Central](https://img.shields.io/maven-central/v/org.apache.dubbo/dubbo-spi-extensions.svg)](https://search.maven.org/search?q=g:org.apache.dubbo%20AND%20a:dubbo-spi-extensions)\n" +
"[![GitHub release](https://img.shields.io/github/release/apache/dubbo-spi-extensions.svg)]");
"[![GitHub release](https://img.shields.io/github/release/apache/dubbo-spi-extensions.svg)]";
System.out.println(x);
System.out.println();
String description = "The purpose of dubbo-spi-extensions is to provide open, community-driven, reusable components to build microservice programs with different needs. These components extend the core of the Apache Dubbo project, but they are separated and decoupled.";
System.out.println(description);

System.out.println();
String usage = "Developers can flexibly choose the required extension dependencies to develop microservice programs based on their needs. The available extensions are as follows:Developers can flexibly choose the required extension dependencies to develop microservice programs based on their needs. ";
System.out.println(usage);
System.out.println();
String asFollow = "The available extensions are as follows:";
System.out.println(asFollow);
System.out.println();

visitFile(file, parentPath, level);
System.out.println();
String contributorTitle = "## Contribution\n";
String thanks = "Thanks to everyone who has contributed!\n";
String contributorImg =
"<a href=\"https://github.com/apache/dubbo-spi-extensions/graphs/contributors\">\n" +
" <img src=\"https://contributors-img.web.app/image?repo=apache/dubbo-spi-extensions\" />\n" +
"</a>\n" ;
System.out.println(contributorTitle);
System.out.println();
System.out.println(thanks);
System.out.println();
System.out.println(contributorImg);
System.out.println();
}

private static void visitFile(File file, String parentPath, int level) {
Expand All @@ -58,7 +85,7 @@ private static void visitFile(File file, String parentPath, int level) {
}

String currentPath = level == 0 ? name : parentPath + "/" + name;
System.out.println(blank + "- [" + name + "]" + "(" + currentPath+ ")");
System.out.println(blank + "- [" + name + "]" + "(" + currentPath + ")");
visitFile(f, currentPath, level + 1);
}
}
Expand Down