Skip to content

Commit e7cab91

Browse files
Update README.md
1 parent be71708 commit e7cab91

2 files changed

Lines changed: 10 additions & 9 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Problem4J Core
22

33
[![Build Status](https://github.com/problem4j/problem4j-core/actions/workflows/gradle-build.yml/badge.svg)](https://github.com/problem4j/problem4j-core/actions/workflows/gradle-build.yml)
4-
[![Sonatype](https://img.shields.io/maven-central/v/io.github.problem4j/problem4j-core)](https://central.sonatype.com/artifact/io.github.problem4j/problem4j-core)
4+
[![Sonatype](https://img.shields.io/maven-central/v/io.github.problem4j/problem4j-core)][maven-central]
55
[![License](https://img.shields.io/github/license/problem4j/problem4j-core)](https://github.com/problem4j/problem4j-core/blob/main/LICENSE)
66

77
This library provides a minimal, framework-agnostic Java model of the [RFC 7807][rfc7807] "Problem Details" object, with
@@ -108,20 +108,22 @@ module org.example.project {
108108
Add library as dependency to Maven or Gradle. See the actual versions on [Maven Central][maven-central]. **Java 8** or
109109
higher is required to use this library.
110110

111+
[![Sonatype](https://img.shields.io/maven-central/v/io.github.problem4j/problem4j-core)][maven-central]
112+
111113
1. Maven:
112114
```xml
113115
<dependencies>
114116
<dependency>
115117
<groupId>io.github.problem4j</groupId>
116118
<artifactId>problem4j-core</artifactId>
117-
<version>1.4.2</version>
119+
<version>{version}</version>
118120
</dependency>
119121
</dependencies>
120122
```
121123
2. Gradle (Groovy or Kotlin DSL):
122124
```groovy
123125
dependencies {
124-
implementation("io.github.problem4j:problem4j-core:1.4.2")
126+
implementation("io.github.problem4j:problem4j-core:{version}")
125127
}
126128
```
127129

RELEASING.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,13 @@
22

33
1. Update `CHANGELOG.md` - change `[Unreleased]` to `[X.Y.Z] - YYYY-MM-DD` and add a new `[Unreleased]` section on top.
44
2. Update `version` property in `gradle.properties` to the new version.
5-
3. Update versions of dependency samples in `README.md`.
6-
4. Commit the changes from (1) and (2) with a message `"Release X.Y.Z"` and push to GitHub.
7-
5. Create an annotated git tag named `vX.Y.Z` with the message `"Release X.Y.Z"` and push it to GitHub. This will
5+
3. Commit the changes from (1) and (2) with a message `"Release X.Y.Z"` and push to GitHub.
6+
4. Create an annotated git tag named `vX.Y.Z` with the message `"Release X.Y.Z"` and push it to GitHub. This will
87
trigger the release workflow, which will build and publish the artifacts to Sonatype repository. You can use the
98
[`./tools/tagrelease`](./tools/tagrelease) script to ensure the tag is correctly formatted and prevent mistakes.
10-
6. Update `version` property in `gradle.properties` to the next snapshot version, for example `1.4.1-SNAPSHOT`.
11-
7. Commit the change from (5) with a message `"Update snapshot version"` and push to GitHub.
12-
8. If the release was made on a maintenance branch, make sure to `merge` or `cherry-pick` the `CHANGELOG.md` entry to
9+
5. Update `version` property in `gradle.properties` to the next snapshot version, for example `1.4.1-SNAPSHOT`.
10+
6. Commit the change from (5) with a message `"Update snapshot version"` and push to GitHub.
11+
7. If the release was made on a maintenance branch, make sure to `merge` or `cherry-pick` the `CHANGELOG.md` entry to
1312
the `main` branch as well.
1413

1514
## Maven Central

0 commit comments

Comments
 (0)