Documentation review #27

Author: fugerit79

CHANGELOG.md

@@ -7,11 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- javadoc badges
+- modules description
+
 ### Changed
 
 - fj-bom version set to 1.3.1
 - Sonar Cloud Maven Build set to use maven profile sonarfugerit and github environmental variable for sonarKey
 
+### Removed
+
+- index.md
+
 ## [8.2.2] - 2023-08-31
 
 ### Fixed

README.md

@@ -4,7 +4,7 @@ Provides helper libraries for other java projects (io, configuration, etc.)
 
 
 [![Keep a Changelog v1.1.0 badge](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735)](CHANGELOG.md) 
-[![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/fj-core.svg)](https://mvnrepository.com/artifact/org.fugerit.java/fj-core) 
+[![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/fj-lib.svg)](https://mvnrepository.com/artifact/org.fugerit.java/fj-lib) 
 [![license](https://img.shields.io/badge/License-Apache%20License%202.0-teal.svg)](https://opensource.org/licenses/Apache-2.0) 
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_fj-lib&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fugerit-org_fj-lib)
 
@@ -20,3 +20,25 @@ Quick start :
 Maven profiles :
 - full (create javadoc and sources package too)
 - test (run tests, by default tests are excluded) 
+
+## module : [fj-core](fj-core/README.md)
+
+[![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/fj-core.svg)](https://mvnrepository.com/artifact/org.fugerit.java/fj-core) 
+[![javadoc](https://javadoc.io/badge2/org.fugerit.java/fj-core/javadoc.svg)](https://javadoc.io/doc/org.fugerit.java/fj-core)
+
+Simple utilities for IO, Configuration, DB, Language types and more.
+
+## module : [fj-core-jvfs](fj-core-jvfs/README.md)
+
+[![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/fj-core-jvfs.svg)](https://mvnrepository.com/artifact/org.fugerit.java/fj-core-jvfs) 
+[![javadoc](https://javadoc.io/badge2/org.fugerit.java/fj-core-jvfs/javadoc.svg)](https://javadoc.io/doc/org.fugerit.java/fj-core-jvfs)
+
+Abstraction layer for a virtual file system (can be based on real file syste, database, class loader etc.)
+
+## module : [fj-tool](fj-tool/README.md)
+
+[![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/fj-tool.svg)](https://mvnrepository.com/artifact/org.fugerit.java/fj-tool) 
+[![javadoc](https://javadoc.io/badge2/org.fugerit.java/fj-tool/javadoc.svg)](https://javadoc.io/doc/org.fugerit.java/fj-tool)
+
+Sample tool wrappers for some of [fj-core](../fj-core/README.md) module functionalities.
+

fj-core-jvfs/README.md

@@ -0,0 +1,8 @@
+# fj-core-jvfs
+
+[fj-lib index](../README.md)
+
+[![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/fj-core-jvfs.svg)](https://mvnrepository.com/artifact/org.fugerit.java/fj-core-jvfs) 
+[![javadoc](https://javadoc.io/badge2/org.fugerit.java/fj-core-jvfs/javadoc.svg)](https://javadoc.io/doc/org.fugerit.java/fj-core-jvfs)
+
+Abstraction layer for a virtual file system (can be based on real file syste, database, class loader etc.)

fj-core/README.md

@@ -1,7 +1,7 @@
-# fugerit-java-core
+# fj-core
 
-Useful resources : 
-* [Fugerit Java Library Home](https://www.fugerit.org/jupiter) - Home page to the project
+[fj-lib index](../README.md)
 
-Quick start : 
- 	mvn clean install
+Simple utilities for IO, Configuration, DB, Language types and more.
+
+![Maven Central](https://mvnrepository.com/artifact/org.fugerit.java/fj-core) ![javadoc](https://javadoc.io/doc/org.fugerit.java/fj-core)

fj-tool/README.md

@@ -0,0 +1,8 @@
+# fj-tool
+
+[fj-lib index](../README.md)
+
+[![Maven Central](https://img.shields.io/maven-central/v/org.fugerit.java/fj-tool.svg)](https://mvnrepository.com/artifact/org.fugerit.java/fj-tool) 
+[![javadoc](https://javadoc.io/badge2/org.fugerit.java/fj-tool/javadoc.svg)](https://javadoc.io/doc/org.fugerit.java/fj-tool)
+
+Sample tool wrappers for some of [fj-core](../fj-core/README.md) module functionalities.