#BAEL-17518 add README descriptions

floison51 · Oct 3, 2019 · 476dbbc · 476dbbc
1 parent 68b080e
commit 476dbbc
Show file tree

Hide file tree

Showing 10 changed files with 36 additions and 12 deletions.
diff --git a/httpclient-simple/README.md b/httpclient-simple/README.md
@@ -1,5 +1,8 @@
-=========
-## This module contains articles that are part of the HTTPClient Ebook
+## HTTPClient Ebook
+
+This module contains articles about HTTPClient that are part of the HTTPClient Ebook.
+
+### Relevant Articles
 
 - [HttpClient 4 – Get the Status Code](https://www.baeldung.com/httpclient-status-code)
 - [HttpClient with SSL](https://www.baeldung.com/httpclient-ssl)

diff --git a/hystrix/README.md b/hystrix/README.md
@@ -1,3 +1,7 @@
+## Hystrix
+
+This module contains articles about Hystrix.
+
 ### Relevant Articles:
 - [Hystrix Integration with Existing Spring Application](https://www.baeldung.com/hystrix-integration-with-spring-aop)
 - [Introduction to Hystrix](https://www.baeldung.com/introduction-to-hystrix)
diff --git a/image-processing/README.md b/image-processing/README.md
@@ -1,2 +1,6 @@
+## Image Processing
+
+This module contains articles about image processing.
+
 ### Relevant Articles:
 - [Working with Images in Java](https://www.baeldung.com/java-images)
diff --git a/immutables/README.md b/immutables/README.md
@@ -1,2 +1,6 @@
+## Immutables
+
+This module contains articles about the Immutables library.
+
 ### Relevant Articles:
 - [Introduction to Immutables](https://www.baeldung.com/immutables)
diff --git a/jackson-2/README.md b/jackson-2/README.md
@@ -1,7 +1,7 @@
-=========
-
 ## Jackson Cookbooks and Examples
 
+This module contains articles about Jackson.
+
 ### The Course
 The "REST With Spring" Classes: http://bit.ly/restwithspring
 
@@ -12,3 +12,4 @@ The "REST With Spring" Classes: http://bit.ly/restwithspring
 - [Converting JSON to CSV in Java](https://www.baeldung.com/java-converting-json-to-csv)
 - [Compare Two JSON Objects with Jackson](https://www.baeldung.com/jackson-compare-two-json-objects)
 - [Calling Default Serializer from Custom Serializer in Jackson](https://www.baeldung.com/jackson-call-default-serializer-from-custom-serializer)
+- More articles: [[<-- prev]](/../jackson)
diff --git a/jackson-simple/README.md b/jackson-simple/README.md
@@ -1,6 +1,7 @@
-=========
 ### Jackson Articles that are also part of the e-book
 
+This module contains articles about Jackson that are also part of the Jackson Ebook.
+
 ###The Course
 The "REST With Spring" Classes: http://bit.ly/restwithspring
 

diff --git a/jackson/README.md b/jackson/README.md
@@ -1,7 +1,7 @@
-=========
-
 ## Jackson Cookbooks and Examples
 
+This module contains articles about Jackson.
+
 ###The Course
 The "REST With Spring" Classes: http://bit.ly/restwithspring
 
@@ -32,4 +32,5 @@ The "REST With Spring" Classes: http://bit.ly/restwithspring
 - [Convert XML to JSON Using Jackson](https://www.baeldung.com/jackson-convert-xml-json)
 - [Deserialize Immutable Objects with Jackson](https://www.baeldung.com/jackson-deserialize-immutable-objects)
 - [Mapping a Dynamic JSON Object with Jackson](https://www.baeldung.com/jackson-mapping-dynamic-object)
+- More articles: [[next -->]](/../jackson-2)
 
diff --git a/java-collections-conversions/README.md b/java-collections-conversions/README.md
@@ -1,7 +1,7 @@
-=========
-
 ## Java Collections Cookbooks and Examples
 
+This module contains articles about conversions among Collection types and arrays in Java.
+
 ### Relevant Articles: 
 - [Converting between an Array and a List in Java](https://www.baeldung.com/convert-array-to-list-and-list-to-array)
 - [Converting between an Array and a Set in Java](https://www.baeldung.com/convert-array-to-set-and-set-to-array)

diff --git a/java-collections-maps-2/README.md b/java-collections-maps-2/README.md
@@ -1,4 +1,8 @@
-## Relevant Articles:
+## Java Collections Cookbooks and Examples
+
+This module contains articles about Map data structures in Java.
+
+### Relevant Articles: 
 - [Map of Primitives in Java](https://www.baeldung.com/java-map-primitives)
 - [Copying a HashMap in Java](https://www.baeldung.com/java-copy-hashmap)
 - [Guide to Java HashMap]()
@@ -10,3 +14,4 @@
 - [Finding the Highest Value in a Java Map](https://www.baeldung.com/java-find-map-max)
 - [Initialize a HashMap in Java](https://www.baeldung.com/java-initialize-hashmap)
 - [Java TreeMap vs HashMap](https://www.baeldung.com/java-treemap-vs-hashmap)
+- More articles: [[<-- prev>]](/../java-collections-maps)
diff --git a/java-collections-maps/README.md b/java-collections-maps/README.md
@@ -1,7 +1,7 @@
-=========
-
 ## Java Collections Cookbooks and Examples
 
+This module contains articles about Map data structures in Java.
+
 ### Relevant Articles: 
 - [Guide to the Guava BiMap](https://www.baeldung.com/guava-bimap)
 - [The Java HashMap Under the Hood](https://www.baeldung.com/java-hashmap)
@@ -13,3 +13,4 @@
 - [Comparing Two HashMaps in Java](https://www.baeldung.com/java-compare-hashmaps)
 - [Immutable Map Implementations in Java](https://www.baeldung.com/java-immutable-maps) 
 - [Guide to Apache Commons MultiValuedMap](https://www.baeldung.com/apache-commons-multi-valued-map)
+- More articles: [[next -->]](/../java-collections-maps-2)