Merge pull request eugenp#7843 from sjmillington/readme-10

[BAEL-17494] - Added readme descriptions 10
siva87 · Oct 1, 2019 · dafe1a3 · dafe1a3
2 parents 326e85e + ae690b0
commit dafe1a3
Show file tree

Hide file tree

Showing 10 changed files with 58 additions and 30 deletions.
diff --git a/spring-mvc-java/README.md b/spring-mvc-java/README.md
@@ -1,8 +1,9 @@
-=========
+## Spring MVC with Java Configuration
 
-## Spring MVC with Java Configuration Example Project
+This module contains articles about Spring MVC with Java configuration
 
 ### The Course
+
 The "REST With Spring" Classes: http://bit.ly/restwithspring
 
 ### Relevant Articles: 

diff --git a/spring-mvc-kotlin/README.md b/spring-mvc-kotlin/README.md
@@ -1,3 +1,7 @@
+## Spring MVC with Kotlin
+
+This module contains articles about Spring MVC with Kotlin
+
 ### Relevant articles
 - [Spring MVC Setup with Kotlin](http://www.baeldung.com/spring-mvc-kotlin)
 - [Working with Kotlin and JPA](http://www.baeldung.com/kotlin-jpa)

diff --git a/spring-mvc-simple-2/README.md b/spring-mvc-simple-2/README.md
@@ -1,2 +1,7 @@
+## Spring MVC Simple 2
+
+This module contains articles about Spring MVC
+
 ## Relevant articles:
 - [How to Read HTTP Headers in Spring REST Controllers](https://www.baeldung.com/spring-rest-http-headers)
+- More articles: [[<-- prev]](/spring-mvc-simple)
diff --git a/spring-mvc-simple/README.md b/spring-mvc-simple/README.md
@@ -1,3 +1,7 @@
+## Spring MVC Simple
+
+This module contains articles about Spring MVC
+
 ## Relevant articles:
 
 - [HandlerAdapters in Spring MVC](http://www.baeldung.com/spring-mvc-handler-adapters)
@@ -8,3 +12,4 @@
 - [Guide to Spring Email](http://www.baeldung.com/spring-email)
 - [Request Method Not Supported (405) in Spring](https://www.baeldung.com/spring-request-method-not-supported-405)
 - [Spring @RequestParam Annotation](https://www.baeldung.com/spring-request-param)
+- More articles: [[more -->]](/spring-mvc-simple-2)
diff --git a/spring-mvc-velocity/README.md b/spring-mvc-velocity/README.md
@@ -1,2 +1,6 @@
+## Spring MVC Velocity
+
+This module contains articles about Spring MVC with Velocity
+
 ### Relevant Articles:
 - [Quick Guide to Spring MVC with Velocity](http://www.baeldung.com/spring-mvc-with-velocity)
diff --git a/spring-mvc-webflow/README.md b/spring-mvc-webflow/README.md
@@ -1,9 +1,7 @@
-=========
+## Spring MVC WebFlow
 
-## Spring MVC with Spring Web Flow
-
-###The Course
+This module contains articles about Spring MVC Web Flow
 
 ### Relevant Articles: 
-- 
+
 - [Guide to Spring Web Flow](http://www.baeldung.com/spring-web-flow)
diff --git a/spring-mvc-xml/README.md b/spring-mvc-xml/README.md
@@ -1,12 +1,10 @@
-=========
+## Spring MVC XML
+
+This module contains articles about Spring MVC with XML configuration
 
 ###The Course
 The "REST With Spring" Classes: http://bit.ly/restwithspring
 
-## Spring MVC with XML Configuration Example Project
-- access a sample jsp page at: `http://localhost:8080/spring-mvc-xml/sample.html`
-
-
 ### Relevant Articles: 
 - [Java Session Timeout](http://www.baeldung.com/servlet-session-timeout)
 - [Returning Image/Media Data with Spring MVC](http://www.baeldung.com/spring-mvc-image-media-data)
@@ -15,4 +13,8 @@ The "REST With Spring" Classes: http://bit.ly/restwithspring
 - [Exploring SpringMVC’s Form Tag Library](http://www.baeldung.com/spring-mvc-form-tags)
 - [web.xml vs Initializer with Spring](http://www.baeldung.com/spring-xml-vs-java-config)
 - [A Java Web Application Without a web.xml](https://www.baeldung.com/java-web-app-without-web-xml)
-- [Validating RequestParams and PathVariables in Spring](https://www.baeldung.com/spring-validate-requestparam-pathvariable)
+- [Validating RequestParams and PathVariables in Spring](https://www.baeldung.com/spring-validate-requestparam-pathvariable)
+
+## Spring MVC with XML Configuration Example Project
+- access a sample jsp page at: `http://localhost:8080/spring-mvc-xml/sample.html`
+
diff --git a/spring-protobuf/README.md b/spring-protobuf/README.md
@@ -1,2 +1,6 @@
+## Spring Protocol Buffers
+
+This module contains articles about Spring with Protocol Buffers
+
 ### Relevant Articles:
 - [Spring REST API with Protocol Buffers](http://www.baeldung.com/spring-rest-api-with-protocol-buffers)
diff --git a/spring-quartz/README.md b/spring-quartz/README.md
@@ -1,26 +1,27 @@
-=========================================================================
+## Spring Quartz
 
-## Scheduling in Spring with Quartz Example Project
+This module contains articles about Spring with Quartz
+
+### Relevant Articles: 
+- [Scheduling in Spring with Quartz](http://www.baeldung.com/spring-quartz-schedule)
+
+
+## #Scheduling in Spring with Quartz Example Project
 This is the first example where we configure a basic scheduler.
+
 ##### Spring boot application, Main class
-###
-```
-org.baeldung.springquartz.SpringQuartzApp
-```
-######
+
+
+`org.baeldung.springquartz.SpringQuartzApp`
 
 ##### Configuration in *application.properties*
-####
 
   - Default: configures scheduler using Spring convenience classes:
-    ```
-    using.spring.schedulerFactory=true
-    ```    
-  - To configure scheduler using Quartz API: 
-    ```
-    using.spring.schedulerFactory=false
-    ```
 
-### Relevant Articles: 
-- [Scheduling in Spring with Quartz](http://www.baeldung.com/spring-quartz-schedule)
+    `using.spring.schedulerFactory=true`
+
+  - To configure scheduler using Quartz API: 
+
+    `using.spring.schedulerFactory=false`
 
+
diff --git a/spring-security-cors/README.md b/spring-security-cors/README.md
@@ -1,3 +1,7 @@
+## Spring Security CORS
+
+This module contains articles about Spring Security with CORS (Cross Origin Requests)
+
 ## Relevant Articles
 
 - [Fixing 401s with CORS Preflights and Spring Security](https://www.baeldung.com/spring-security-cors-preflight)