Skip to content

Commit d163302

Browse files
authored
Update Maven badge and documentation notes
Updated Maven badge to reflect version 3.9 and improved documentation notes. [skip ci]
1 parent ce07960 commit d163302

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<p align="center">
66
<!-- Note: do not put inner tags on newlines within <a/>, it messes up the rendering of text decorations leaving blue underlines between badges. -->
77
<img alt="Java 17+" src="https://img.shields.io/badge/Java-17+-red?logo=openjdk&logoColor=white">
8-
<img alt="Maven 3.9" src="https://img.shields.io/badge/maven-3.8,%204.x-blue?logo=apache-maven">
8+
<img alt="Maven 3.9" src="https://img.shields.io/badge/maven-3.9,%204.x-blue?logo=apache-maven">
99
<img alt="GitHub License" src="https://img.shields.io/github/license/ascopes/protobuf-maven-plugin">
1010
<a href="https://github.com/ascopes/protobuf-maven-plugin/actions/workflows/build.yml"><img alt="Build Status" src="https://github.com/ascopes/protobuf-maven-plugin/actions/workflows/build.yml/badge.svg?branch=main"></a>
1111
<a href="https://codecov.io/gh/ascopes/protobuf-maven-plugin"><img alt="Coverage" src="https://img.shields.io/codecov/c/github/ascopes/protobuf-maven-plugin/main"></a>
@@ -14,16 +14,16 @@
1414
<img alt="GitHub Release Date" src="https://img.shields.io/github/release-date/ascopes/protobuf-maven-plugin">
1515
</p>
1616

17-
1817
A scratch-built, modern Maven plugin for seamless `protoc` integration. Provides support for native
1918
and JVM-based `protoc` plugins, as well as automatic dependency resolution and incremental code
2019
generation.
2120

22-
> [!NOTE]
23-
> Full documentation with usage examples can be
24-
> found [within the plugin documentation](https://ascopes.github.io/protobuf-maven-plugin),
25-
> and examples are
26-
> present [in the integration tests](https://github.com/ascopes/protobuf-maven-plugin/tree/main/protobuf-maven-plugin/src/it).
21+
Full documentation with usage examples can be found [within the plugin documentation](https://ascopes.github.io/protobuf-maven-plugin),
22+
and examples are present [in the integration tests](https://github.com/ascopes/protobuf-maven-plugin/tree/main/protobuf-maven-plugin/src/it).
23+
24+
> ![NOTE]
25+
> The v4 release of this plugin requires a minimum of Java 17 and Maven 3.9 to operate. If you
26+
> require the ability to use Maven 3.8 or Java 11, please use the latest v3 release from Maven Central!
2727
2828
## Quick start
2929

0 commit comments

Comments
 (0)