keep a changelog format

CHANGELOG.md

@@ -1,14 +1,18 @@
-# fj-doc-guides changelog
+# Changelog
 
-## 0.1.0-rc.3 - 2023-08-13
-* [Project history](src/docs/common/history.md) section
-* [Doc Format Summary](src/docs/common/doc_format_summary.md) entry point section
-* [From XML to JSON or YAML source](src/docs/common/doc_from_xml_to_json_or_yaml.md) section
+All notable changes to this project will be documented in this file.
 
-## 0.1.0-rc.2 - 2023-08-06
-* [Venus Guide E001 : Hello World PDF JSON Source](fj-doc-guides-E001-hello-world-pdf-json-source/README.md)
-* Started guidelines section
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## 0.1.0-rc.1 - 2023-07-31
-* [Venus Guide A001 : Hello World PDF](fj-doc-guides-A001-hello-world-pdf/README.md)
-* Initial project setup
+## [Unreleased]
+
+### Added
+
+- [Project history](src/docs/common/history.md) section
+- [Doc Format Summary](src/docs/common/doc_format_summary.md) entry point section
+- [From XML to JSON or YAML source](src/docs/common/doc_from_xml_to_json_or_yaml.md) section
+- [Venus Guide E001 : Hello World PDF JSON Source](fj-doc-guides-E001-hello-world-pdf-json-source/README.md)
+- Started guidelines section
+- [Venus Guide A001 : Hello World PDF](fj-doc-guides-A001-hello-world-pdf/README.md)
+- badges to README.md

README.md

@@ -2,7 +2,14 @@
 
 This projects provides simple guides to [Venus - Fugerit Document Generation Framework (fj-doc)](https://github.com/fugerit-org/fj-doc) project.
 
-See the [CHANGELOG.md](CHANGELOG.md) for project updates.
+[![Keep a Changelog v1.1.0 badge](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735)](https://github.com/fugerit-org/fj-doc-guides/blob/main/CHANGELOG.md) 
+[![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-doc-guides&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fugerit-org_fj-doc-guides)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_fj-doc-guides&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fugerit-org_fj-doc-guides)
+
+![Java runtime version](https://img.shields.io/badge/run%20on-java%208+-%23113366.svg?style=for-the-badge&logo=openjdk&logoColor=white)
+![Java build version](https://img.shields.io/badge/build%20on-java%2011+-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white)
+![Apache Maven](https://img.shields.io/badge/Apache%20Maven-3.9.0+-C71A36?style=for-the-badge&logo=Apache%20Maven&logoColor=white)
 
 ## Index