[Gradle] Add ReadMe.md to k.g.p-api module

^KT-54029 Verification Pending
2022-09-19 15:41:42 +02:00
parent bdfbac07d9
commit 7a8250cf17
1 changed files with 13 additions and 0 deletions
@@ -0,0 +1,13 @@
+## Gradle Plugin Api
+
+Lightweight module defining the API surface of the Kotlin Gradle Plugin. 
+
+### Binary Compatibility Validation
+This module is tested for Binary Compatibility Validation by the :tools:binary-compatibility-validator module. 
+Please see [ReadMe.md](../binary-compatibility-validator/ReadMe.md)
+
+You can execute binary compatibility validation by a shared run-configuration in the IDE
+`/Tests/Test: binary compatibility` 
+
+In order to check in changes you can launch 
+`Test/Test: binary compatibility [overwrite]`