Skip to content

Commit

Permalink
Prepare doc for next release
Browse files Browse the repository at this point in the history
  • Loading branch information
charphi committed Aug 28, 2024
1 parent b00bda1 commit 1c1bdc1
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 1c1bdc1

Please sign in to comment.