From 1c1bdc120dbdd39264b1f7327f0dc9416d566b81 Mon Sep 17 00:00:00 2001
From: Philippe Charles <philippe.charles@nbb.be>
Date: Wed, 28 Aug 2024 14:53:03 +0200
Subject: [PATCH] Prepare doc for next release

---
 CHANGELOG.md | 11 +++++++++++
 README.md    | 31 +++++++++++++++++++++++++++++++
 2 files changed, 42 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 34efa8b..0daac20 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,17 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+This release adds a release command that greatly improves the use of heylogs in automations.  
+It also brings some code refactoring to split the code into more manageable parts.
+
+### Added
+
+- Add release command to promote the Unreleased section into a new release version section [#10](https://github.com/nbbrd/heylogs/issues/10)
+
+### Changed
+
+- Improve code modularization
+
 ## [0.8.1] - 2024-04-18
 
 ### Fixed
diff --git a/README.md b/README.md
index 99523fb..6ba9d33 100644
--- a/README.md
+++ b/README.md
@@ -17,11 +17,40 @@ Features:
 - Checks format
 - Summarizes content
 - Extracts versions
+- Modify content
 
 [ [Library](#library) | [Command-line tool](#command-line-tool) | [Maven plugin](#maven-plugin) | [Badges](#badges) | [Developing](#developing) | [Contributing](#contributing)  | [Licensing](#licensing) | [Related work](#related-work)]
 
 ## Library
 
+Heylogs is available as a Java library.  
+_Note that the API is currently in beta and might change frequently._
+
+```xml
+<dependencies>
+   <dependency>
+      <groupId>com.github.nbbrd.heylogs</groupId>
+      <artifactId>heylogs-api</artifactId>
+      <version>_VERSION_</version>
+   </dependency>
+   <dependency>
+      <groupId>com.github.nbbrd.heylogs</groupId>
+      <artifactId>heylogs-ext-github</artifactId>
+      <version>_VERSION_</version>
+      <scope>runtime</scope>
+   </dependency>
+   ...
+</dependencies>
+```
+
+The API is straightforward and has a single point of entry:
+```java
+Heylogs heylogs = Heylogs.ofServiceLoader();
+Document flexmarkDocument = parseFileWithFlexmark(file);
+List<Problem> problems = heylogs.checkFormat(flexmarkDocument);
+...
+```
+
 `WIP`
 
 ## Command-line tool
@@ -37,6 +66,7 @@ It provides the following commands:
 | `check`   | Check format      |
 | `scan`    | Summarize content |
 | `extract` | Extract versions  |
+| `release` | Release changes   |
 | `list`    | List resources    |
 
 It follows the Unix philosophy of [“Do one thing and do it well“](https://en.wikipedia.org/wiki/Unix_philosophy#Do_One_Thing_and_Do_It_Well) by performing a single function and beeing composable.
@@ -146,6 +176,7 @@ It provides the following goals:
 | `check`   | Check format      |
 | `scan`    | Summarize content |
 | `extract` | Extract versions  |
+| `release` | Release changes   |
 | `list`    | List resources    |
 
 ### Examples