Skip to content

Commit b5749aa

Browse files
committed
Update README.md
1 parent e3876a3 commit b5749aa

File tree

1 file changed

+23
-15
lines changed

1 file changed

+23
-15
lines changed

README.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,42 @@
1-
# Gradle Shadow
1+
# Shadow
22

33
Gradle plugin for creating fat/uber JARs with support for package relocation.
44

55
> [!NOTE]\
6-
> Previously this plugin was developed by [@johnrengelman](https://github.com/johnrengelman) and published under the ID [`com.github.johnrengelman.shadow`](https://plugins.gradle.org/plugin/com.github.johnrengelman.shadow)
7-
> before maintenance was transferred to the [GradleUp organization](https://github.com/GradleUp) to ensure future development, see [#908](https://github.com/GradleUp/shadow/issues/908).
6+
> Previously this plugin was developed by [@johnrengelman](https://github.com/johnrengelman) and published under the
7+
> ID [`com.github.johnrengelman.shadow`][johnrengelman's]
8+
> before maintenance was transferred to the [GradleUp organization](https://github.com/GradleUp) to ensure future
9+
> development, see [#908](https://github.com/GradleUp/shadow/issues/908).
810
>
9-
> If you are still using the old plugin ID in your build script, we recommend to switch to the new plugin ID [`com.gradleup.shadow`](https://plugins.gradle.org/plugin/com.gradleup.shadow)
11+
> If you are still using the old plugin ID in your build script, we recommend to switch to the new plugin ID [
12+
`com.gradleup.shadow`][gradleup's]
1013
> and update to the latest version to receive all the latest bug fixes and improvements.
1114
1215
## Documentation
1316

14-
Read the [User Guide](https://gradleup.com/shadow/)!
17+
- [User Guide](https://gradleup.com/shadow/)
18+
- [Change Log](docs/changes/README.md)
1519

1620
## Current Status
1721

1822
[![Maven Central](https://img.shields.io/maven-central/v/com.gradleup.shadow/shadow-gradle-plugin)](https://central.sonatype.com/artifact/com.gradleup.shadow/shadow-gradle-plugin)
1923
[![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/com.gradleup.shadow/shadow-gradle-plugin?&server=https://oss.sonatype.org/)](https://oss.sonatype.org/content/repositories/snapshots/com/gradleup/shadow/)
2024
[![Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/com.gradleup.shadow)](https://plugins.gradle.org/plugin/com.gradleup.shadow)
21-
[![CI](https://github.com/GradleUp/shadow/actions/workflows/ci.yml/badge.svg?branch=main&event=push)](https://github.com/GradleUp/shadow/actions/workflows/ci.yml?query=branch:main+event:push)
25+
[![CI](https://github.com/GradleUp/shadow/actions/workflows/build.yml/badge.svg?branch=main&event=push)](https://github.com/GradleUp/shadow/actions/workflows/build.yml?query=branch:main+event:push)
2226
[![License](https://img.shields.io/github/license/GradleUp/shadow.svg)](LICENSE)
2327

24-
## Latest Test Compatibility
28+
## Compatibility Matrix
2529

26-
| Gradle Version | Shadow Version |
27-
|----------------|----------------|
28-
| 5.x | 5.2.0 - 6.0.0 |
29-
| 6.x | 5.2.0 - 6.1.0 |
30-
| 7.x | 7.0.0+ |
31-
| 8.0 - 8.2.x | 8.0.0 - 8.1.1 |
32-
| 8.3+ | 8.3.0+ |
30+
| Shadow Version | Min Gradle Version | Min Java Version | Plugin ID |
31+
|----------------|--------------------|------------------|------------------------------------------------------|
32+
| 5.2.0 - 6.1.0 | 5.x - 6.x | 7 | [`com.github.johnrengelman.shadow`][johnrengelman's] |
33+
| 6.1.0+ | 6.x | 8 | [`com.github.johnrengelman.shadow`][johnrengelman's] |
34+
| 7.0.0+ | 7.x | 8 | [`com.github.johnrengelman.shadow`][johnrengelman's] |
35+
| 8.0.0+ | 8.0 | 8 | [`com.github.johnrengelman.shadow`][johnrengelman's] |
36+
| 8.3.0+ | 8.3 | 8 | [`com.gradleup.shadow`][gradleup's] |
37+
| 9.0.0+ | 8.3 | 11 | [`com.gradleup.shadow`][gradleup's] |
3338

34-
**NOTE**: Shadow v5.+ is compatible with Gradle 5.x - 6.x and Java 7 - 15 _only_, v6.1.0+ requires Java 8+.
39+
40+
41+
[johnrengelman's]: https://plugins.gradle.org/plugin/com.github.johnrengelman.shadow
42+
[gradleup's]: https://plugins.gradle.org/plugin/com.gradleup.shadow

0 commit comments

Comments
 (0)