mercyblitz closed pull request #65: Polish readme. URL: https://github.com/apache/incubator-dubbo-spring-boot-project/pull/65
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/README.md b/README.md index 70beda35..1f120a7d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # Dubbo Spring Boot Project -[Dubbo](https://github.com/alibaba/dubbo) Spring Boot Project makes it easy to create [Spring Boot](https://github.com/spring-projects/spring-boot/) application using Dubbo as RPC Framework. What's more , it aslo provides +[Dubbo](https://github.com/alibaba/dubbo) Spring Boot Project makes it easy to create [Spring Boot](https://github.com/spring-projects/spring-boot/) application using Dubbo as RPC Framework. What's more, it aslo provides -* [auto-configure features](dubbo-spring-boot-autoconfigure) (e.g.annotation-driven, auto configuration, externalized configuration). -* [production-ready features](dubbo-spring-boot-actuator) (e.g.security, health checks, externalized configuration). +* [auto-configure features](dubbo-spring-boot-autoconfigure) (e.g., annotation-driven, auto configuration, externalized configuration). +* [production-ready features](dubbo-spring-boot-actuator) (e.g., security, health checks, externalized configuration). @@ -43,11 +43,11 @@ If your project failed to resolve the dependency, try to add the following repos ## Getting Started -If you don't know about Dubbo , please take a few minutes to learn http://dubbo.io/ . After that you could dive deep into dubbo [user guide](http://dubbo.io/books/dubbo-user-book-en/). +If you don't know about Dubbo, please take a few minutes to learn http://dubbo.io/. After that you could dive deep into dubbo [user guide](http://dubbo.io/books/dubbo-user-book-en/). -Usually , There are two usage scenarios for Dubbo applications , one is Dubbo service(s) provider , another is Dubbo service(s) consumer, thus let's get a quick start on them. +Usually, There are two usage scenarios for Dubbo applications, one is Dubbo service(s) provider, another is Dubbo service(s) consumer, thus let's get a quick start on them. -First of all , we suppose an interface as Dubbo RPC API that a service provider exports and a service client consumes : +First of all, we suppose an interface as Dubbo RPC API that a service provider exports and a service client consumes: ```java public interface DemoService { @@ -61,7 +61,7 @@ public interface DemoService { ### Dubbo service(s) provider -Service Provider implements `DemoService` : +Service Provider implements `DemoService`: ```java @Service( @@ -81,7 +81,7 @@ public class DefaultDemoService implements DemoService { -then , provides a bootstrap class : +then, provides a bootstrap class: ```java @SpringBootApplication @@ -98,7 +98,7 @@ public class DubboProviderDemo { -last , configures `application.properties` : +last, configures `application.properties`: ```properties # Spring boot application @@ -106,7 +106,7 @@ spring.application.name = dubbo-provider-demo server.port = 9090 management.port = 9091 -# Base packages to scan Dubbo Components (e.g @Service , @Reference) +# Base packages to scan Dubbo Components (e.g., @Service, @Reference) dubbo.scan.basePackages = com.alibaba.boot.dubbo.demo.provider.service # Dubbo Config properties @@ -130,7 +130,7 @@ dubbo.registry.address = N/A -More details , please refer to [Dubbo Provider Sample](dubbo-spring-boot-samples/dubbo-spring-boot-sample-provider). +More details, please refer to [Dubbo Provider Sample](dubbo-spring-boot-samples/dubbo-spring-boot-sample-provider). @@ -138,7 +138,7 @@ More details , please refer to [Dubbo Provider Sample](dubbo-spring-boot-samples -Service consumer requires Spring Beans to reference `DemoService` : +Service consumer requires Spring Beans to reference `DemoService`: ```java @RestController @@ -159,7 +159,7 @@ public class DemoConsumerController { -then , also provide a bootstrap class : +then, also provide a bootstrap class: ```java @SpringBootApplication(scanBasePackages = "com.alibaba.boot.dubbo.demo.consumer.controller") @@ -176,7 +176,7 @@ public class DubboConsumerDemo { -last , configures `application.properties` : +last, configures `application.properties`: ```properties # Spring boot application @@ -198,11 +198,11 @@ dubbo.protocol.port = 12345 -If `DubboProviderDemo` works well , please mark sure Dubbo service(s) is active. +If `DubboProviderDemo` works well, please mark sure Dubbo service(s) is active. -More details , please refer to [Dubbo Consumer Sample](dubbo-spring-boot-samples/dubbo-spring-boot-sample-consumer) +More details, please refer to [Dubbo Consumer Sample](dubbo-spring-boot-samples/dubbo-spring-boot-sample-consumer) @@ -211,7 +211,7 @@ More details , please refer to [Dubbo Consumer Sample](dubbo-spring-boot-samples Having trouble with Dubbo Spring Boot? We’d like to help! - If you are upgrading, read the [release notes](https://github.com/dubbo/dubbo-spring-boot-project/releases) for upgrade instructions and "new and noteworthy" features. -- Ask a question - You can join [ours google groups](https://groups.google.com/group/dubbo) , or subscribe [Dubbo User Mailling List](mailto:[email protected]). +- Ask a question - You can join [ours google groups](https://groups.google.com/group/dubbo), or subscribe [Dubbo User Mailling List](mailto:[email protected]). - Report bugs at [github.com/dubbo/dubbo-spring-boot-project/issues](https://github.com/dubbo/dubbo-spring-boot-project/issues). @@ -219,7 +219,7 @@ Having trouble with Dubbo Spring Boot? We’d like to help! ## Building from Source -If you want to try out thr latest features of Dubbo Spring Boot , it can be easily built with the [maven wrapper](https://github.com/takari/maven-wrapper). Your JDK is 1.7 or above. +If you want to try out thr latest features of Dubbo Spring Boot, it can be easily built with the [maven wrapper](https://github.com/takari/maven-wrapper). Your JDK is 1.7 or above. ``` $ ./mvnw clean install @@ -229,7 +229,7 @@ $ ./mvnw clean install ## Modules -There are some modules in Dubbo Spring Boot Project , let's take a look at below overview : +There are some modules in Dubbo Spring Boot Project, let's take a look at below overview: @@ -247,7 +247,7 @@ The main usage of `dubbo-spring-boot-parent` is providing dependencies managemen ### [dubbo-spring-boot-actuator](dubbo-spring-boot-actuator) -`dubbo-spring-boot-actuator` provides production-ready features (e.g. [health checks](https://github.com/dubbo/dubbo-spring-boot-project/tree/master/dubbo-spring-boot-actuator#health-checks), [endpoints](https://github.com/dubbo/dubbo-spring-boot-project/tree/master/dubbo-spring-boot-actuator#endpoints), and [externalized configuration](https://github.com/dubbo/dubbo-spring-boot-project/tree/master/dubbo-spring-boot-actuator#externalized-configuration)). +`dubbo-spring-boot-actuator` provides production-ready features (e.g., [health checks](https://github.com/dubbo/dubbo-spring-boot-project/tree/master/dubbo-spring-boot-actuator#health-checks), [endpoints](https://github.com/dubbo/dubbo-spring-boot-project/tree/master/dubbo-spring-boot-actuator#endpoints), and [externalized configuration](https://github.com/dubbo/dubbo-spring-boot-project/tree/master/dubbo-spring-boot-actuator#externalized-configuration)). @@ -267,16 +267,16 @@ The samples project of Dubbo Spring Boot that includes two parts: Dubbo Service will be exported on localhost with port `12345`. -* [Health Checks](dubbo-spring-boot-actuator#health-checks) : http://localhost:9091/health -* [Dubbo Endpoint](dubbo-spring-boot-actuator#endpoints) : http://localhost:9091/dubbo +* [Health Checks](dubbo-spring-boot-actuator#health-checks): http://localhost:9091/health +* [Dubbo Endpoint](dubbo-spring-boot-actuator#endpoints): http://localhost:9091/dubbo #### [Dubbo Consumer Sample](dubbo-spring-boot-samples/dubbo-spring-boot-sample-consumer) -Dubbo Service will be consumed at Spring WebMVC `Controller` . +Dubbo Service will be consumed at Spring WebMVC `Controller`. -* Demo `Controller` : http://localhost:8080/sayHello?name=HelloWorld -* [Health Checks](dubbo-spring-boot-actuator#health-checks) : http://localhost:8081/health -* [Dubbo Endpoint](dubbo-spring-boot-actuator#endpoints) : http://localhost:8081/dubbo +* Demo `Controller`: http://localhost:8080/sayHello?name=HelloWorld +* [Health Checks](dubbo-spring-boot-actuator#health-checks): http://localhost:8081/health +* [Dubbo Endpoint](dubbo-spring-boot-actuator#endpoints): http://localhost:8081/dubbo ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
