Add info in readme.

raphw · Jan 16, 2021 · ca89db8 · ca89db8
1 parent 0b7dcdf
commit ca89db8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/byte-buddy-gradle-plugin/README.md b/byte-buddy-gradle-plugin/README.md
@@ -24,4 +24,6 @@ This example transformation uses a standard plugin that is shipped with Byte Bud
 
 A custom can declare a constructor that can take arguments of type `File`, `BuildLogger` or a Gradle-specific `Logger` where the class file root directory or an appropriate logger is provided. It is also possible to supply an argument explicitly by specifying an argument in the plugin configuration.
 
+A plugin can be applied automatically if the plugin's containing jar file declares the plugin's name in the *META-INF/net.bytebuddy/build.plugins* file.
+
 The plugin offers the implementation of custom tasks, the `ByteBuddyTask` transforms classes within a folder and writes it to another folder while using Gradle's incremental build feature what requires Gradle 6 or later. The `ByteBuddySimpleTask` does not support incremental build but works from Gradle 2 on up whereas the `ByteBuddyJarTask` allows the transformation of a bundled jar file. Insight into the Byte Buddy plugins autoconfiguration can be found in the debug log.
diff --git a/byte-buddy-maven-plugin/README.md b/byte-buddy-maven-plugin/README.md
@@ -36,4 +36,6 @@ This example transformation uses a standard plugin that is shipped with Byte Bud
 
 A plugin can declare a constructor that takes arguments of type `File`, `BuildLogger` or a Gradle-specific `Logger` where the class file root directory or an appropriate logger is provided. It is also possible to supply an argument explicitly by specifying an argument in the plugin configuration.
 
+A plugin can be applied automatically when it is included as a dependency of the *byte-buddy-maven-plugin* configuration and if the plugin's containing jar file declares the plugin's name in the *META-INF/net.bytebuddy/build.plugins* file.
+
 The plugin supports Maven's `BuildContext` and incremental build feature which is currently supported by the Eclipse IDE. To enable it, it needs to be activated explicitly by setting the `incremental` property to `true`.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,4 +24,6 @@ This example transformation uses a standard plugin that is shipped with Byte Bud

		A custom can declare a constructor that can take arguments of type `File`, `BuildLogger` or a Gradle-specific `Logger` where the class file root directory or an appropriate logger is provided. It is also possible to supply an argument explicitly by specifying an argument in the plugin configuration.

		A plugin can be applied automatically if the plugin's containing jar file declares the plugin's name in the META-INF/net.bytebuddy/build.plugins file.

		The plugin offers the implementation of custom tasks, the `ByteBuddyTask` transforms classes within a folder and writes it to another folder while using Gradle's incremental build feature what requires Gradle 6 or later. The `ByteBuddySimpleTask` does not support incremental build but works from Gradle 2 on up whereas the `ByteBuddyJarTask` allows the transformation of a bundled jar file. Insight into the Byte Buddy plugins autoconfiguration can be found in the debug log.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -36,4 +36,6 @@ This example transformation uses a standard plugin that is shipped with Byte Bud

		A plugin can declare a constructor that takes arguments of type `File`, `BuildLogger` or a Gradle-specific `Logger` where the class file root directory or an appropriate logger is provided. It is also possible to supply an argument explicitly by specifying an argument in the plugin configuration.

		A plugin can be applied automatically when it is included as a dependency of the byte-buddy-maven-plugin configuration and if the plugin's containing jar file declares the plugin's name in the META-INF/net.bytebuddy/build.plugins file.

		The plugin supports Maven's `BuildContext` and incremental build feature which is currently supported by the Eclipse IDE. To enable it, it needs to be activated explicitly by setting the `incremental` property to `true`.