From afbc737aba55a49cf64dbf71335ab9e2d6ea1507 Mon Sep 17 00:00:00 2001 From: Andrew Oberstar Date: Sat, 5 Oct 2024 11:53:50 -0500 Subject: [PATCH] chore: Document Kotlin issue Fixes #361 --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 86bd3ee9..543adc75 100644 --- a/README.md +++ b/README.md @@ -49,11 +49,14 @@ It also provides a Gradle plugin to easily get a Grgit instance for the build's - [Documentation Site](https://ajoberstar.org/grgit/main/index.html) - [Release Notes](https://github.com/ajoberstar/grgit/releases) -## Simple Usage in Gradle - > [!IMPORTANT] > grgit **is not compatible** with Gradle's configuration cache and is **out of scope** for future work on grgit. +## Simple Usage in Gradle + +> [!NOTE] +> `org.ajoberstar.grgit` has poor compatibility with Kotlin scripts. See #361 for an example. + Apply the `org.ajoberstar.grgit` plugin in any project that needs to access a `Grgit` instance. > [!NOTE]