#BAEL-17527 add README descriptions (eugenp#7964)

snow8261 · Oct 9, 2019 · b3a46b8 · b3a46b8
1 parent 804384f
commit b3a46b8
Show file tree

Hide file tree

Showing 13 changed files with 54 additions and 12 deletions.
diff --git a/oauth2-framework-impl/README.md b/oauth2-framework-impl/README.md
@@ -1,3 +1,7 @@
+## OAuth 2.0 Implementation
+
+This module contains articles about the implementation of OAuth2 with Java EE.
+
 ### Relevant Articles
 
 - [Implementing The OAuth 2.0 Authorization Framework Using Java EE](https://www.baeldung.com/java-ee-oauth2-implementation)
diff --git a/reactor-core/README.md b/reactor-core/README.md
@@ -1,3 +1,7 @@
+## Reactor Core
+
+This module contains articles about Reactor Core.
+
 ### Relevant articles
 
 - [Intro To Reactor Core](https://www.baeldung.com/reactor-core)

diff --git a/resteasy/README.md b/resteasy/README.md
@@ -1,7 +1,6 @@
-=========
-
-## A Guide to RESTEasy
+## RESTEasy
 
+This module contains articles about RESTEasy.
 
 ### Relevant Articles:
 - [A Guide to RESTEasy](https://www.baeldung.com/resteasy-tutorial)

diff --git a/restx/README.md b/restx/README.md
@@ -1,4 +1,8 @@
-# Relevant Articles
+## RESTX
+
+This module contains articles about RESTX.
+
+### Relevant Articles
 
 * [Introduction to RESTX](https://www.baeldung.com/java-restx)
 
diff --git a/rsocket/README.md b/rsocket/README.md
@@ -1,3 +1,7 @@
-Relevant articles
+## RSocket
+
+This module contains articles about RSocket.
+
+### Relevant articles
 
 - [Introduction to RSocket](https://www.baeldung.com/rsocket)
diff --git a/rule-engines/README.md b/rule-engines/README.md
@@ -1,3 +1,7 @@
-## Relevant articles:
+## Rule Engines
+
+This module contains articles about rule engines. Articles specific to a given rule engine go in the relevant submodule.
+
+### Relevant articles:
 
 - [List of Rules Engines in Java](https://www.baeldung.com/java-rule-engines)
diff --git a/rxjava-2/README.md b/rxjava-2/README.md
@@ -1,4 +1,8 @@
-## Relevant articles:
+## RxJava
+
+This module contains articles about RxJava.
+
+### Relevant articles:
 
 - [RxJava and Error Handling](https://www.baeldung.com/rxjava-error-handling)
 - [RxJava 2 – Flowable](https://www.baeldung.com/rxjava-2-flowable)
@@ -7,3 +11,4 @@
 - [Combining RxJava Completables](https://www.baeldung.com/rxjava-completable)
 - [Converting Synchronous and Asynchronous APIs to Observables using RxJava2](https://www.baeldung.com/rxjava-apis-to-observables)
 - [RxJava Hooks](https://www.baeldung.com/rxjava-hooks)
+- More articles: [[<-- prev]](/rxjava)
diff --git a/rxjava/README.md b/rxjava/README.md
@@ -1,4 +1,8 @@
-## Relevant articles:
+## RxJava
+
+This module contains articles about RxJava.
+
+### Relevant articles:
 
 - [Dealing with Backpressure with RxJava](https://www.baeldung.com/rxjava-backpressure)
 - [How to Test RxJava?](https://www.baeldung.com/rxjava-testing)
@@ -13,3 +17,4 @@
 - [Filtering Observables in RxJava](https://www.baeldung.com/rxjava-filtering)
 - [RxJava One Observable, Multiple Subscribers](https://www.baeldung.com/rxjava-multiple-subscribers-observable)
 - [Difference Between Flatmap and Switchmap in RxJava](https://www.baeldung.com/rxjava-flatmap-switchmap)
+- More articles: [[next -->]](/rxjava-2)
diff --git a/spf4j/README.md b/spf4j/README.md
@@ -1,3 +1,7 @@
-## Relevant articles:
+## SPF4J
+
+This module contains articles about SPF4J.
+
+### Relevant articles:
 
 - [Introduction to SPF4J](https://www.baeldung.com/spf4j)
diff --git a/spring-boot-performance/README.md b/spring-boot-performance/README.md
@@ -1,3 +1,7 @@
+## Spring Boot Performance
+
+This module contains articles about Spring Boot performance.
+
 ### Relevant Articles
 
 - [Lazy Initialization in Spring Boot 2](https://www.baeldung.com/spring-boot-lazy-initialization)
diff --git a/spring-boot-properties/README.md b/spring-boot-properties/README.md
@@ -1,3 +1,7 @@
+## Spring Boot Properties
+
+This module contains articles about Properties in Spring Boot.
+
 ### Relevant Articles:
 - [Reloading Properties Files in Spring](https://www.baeldung.com/spring-reloading-properties)
 - [Guide to @ConfigurationProperties in Spring Boot](https://www.baeldung.com/configuration-properties-in-spring-boot)

diff --git a/spring-mvc-basics/README.md b/spring-mvc-basics/README.md
@@ -1,6 +1,7 @@
-=========
+## Spring MVC Basics
 
-## Spring MVC Basics with Java Configuration Example Project
+This module contains articles about the basics of Spring MVC. Articles about more specific areas of Spring MVC have
+their own module. 
 
 ### The Course
 The "REST With Spring" Classes: http://bit.ly/restwithspring

diff --git a/twitter4j/README.md b/twitter4j/README.md
@@ -1,6 +1,6 @@
 ## Twitter4J
 
-This module contains articles about Twitter4J
+This module contains articles about Twitter4J.
 
 ### Relevant articles