diff --git a/README.md b/README.md index 1a9345651..7770daaf5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Shadow -Gradle plugin for creating fat/uber JARs with support for package relocation. +A Gradle plugin for creating fat/uber JARs, transforming files, relocating packages, and optimizing applications +with R8/ProGuard. The Gradle counterpart to Maven's Shade plugin. > [!NOTE]\ > Previously this plugin was developed by [@johnrengelman](https://github.com/johnrengelman) and published under the diff --git a/docs/README.md b/docs/README.md index ba1d492d9..a98e1d47f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,10 +4,8 @@ # Introduction -Shadow is a Gradle plugin for combining a project's dependency classes and resources into a single -output Jar. The combined Jar is often referred to a _fat-jar_ or _uber-jar_. -Shadow utilizes [`JarInputStream`][JarInputStream] and [`JarOutputStream`][JarOutputStream] to efficiently process -dependent libraries into the output jar without incurring the I/O overhead of expanding the jars to disk. +A Gradle plugin for creating fat/uber JARs, transforming files, relocating packages, and optimizing applications +with R8/ProGuard. The Gradle counterpart to Maven's Shade plugin. !!! warning "Plugin ID Change" @@ -68,7 +66,5 @@ library's dependencies will not conflict with the same dependency being declared -[JarInputStream]: https://docs.oracle.com/javase/8/docs/api/java/util/jar/JarInputStream.html -[JarOutputStream]: https://docs.oracle.com/javase/8/docs/api/java/util/jar/JarOutputStream.html [johnrengelman's]: https://plugins.gradle.org/plugin/com.github.johnrengelman.shadow [gradleup's]: https://plugins.gradle.org/plugin/com.gradleup.shadow diff --git a/gradle.properties b/gradle.properties index 878707ae5..d712a5a79 100644 --- a/gradle.properties +++ b/gradle.properties @@ -22,7 +22,7 @@ POM_ARTIFACT_ID=shadow-gradle-plugin VERSION_NAME=9.7.0-SNAPSHOT POM_NAME=Shadow Gradle Plugin -POM_DESCRIPTION=Gradle plugin to create fat/uber JARs, apply file transforms, and relocate packages for applications and libraries. Gradle version of Maven's Shade plugin. +POM_DESCRIPTION=Gradle plugin for creating fat/uber JARs, transforming files, relocating packages, and optimizing applications with R8/ProGuard. The Gradle counterpart to Maven's Shade plugin. POM_INCEPTION_YEAR=2024 POM_URL=https://github.com/GradleUp/shadow diff --git a/mkdocs.yml b/mkdocs.yml index a74080f91..f0b784109 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,7 +5,7 @@ site_name: Shadow Gradle Plugin repo_name: Shadow repo_url: https://github.com/GradleUp/shadow -site_description: "Gradle plugin to create fat/uber JARs, apply file transforms, and relocate packages for applications and libraries" +site_description: "A Gradle plugin for creating fat/uber JARs, transforming files, relocating packages, and optimizing applications with R8/ProGuard. The Gradle counterpart to Maven's Shade plugin." site_author: GradleUp developers remote_branch: gh-pages edit_uri: edit/main/docs