Skip to content

Commit afbc737

Browse files
committed
chore: Document Kotlin issue
Fixes #361
1 parent 41046ec commit afbc737

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,14 @@ It also provides a Gradle plugin to easily get a Grgit instance for the build's
4949
- [Documentation Site](https://ajoberstar.org/grgit/main/index.html)
5050
- [Release Notes](https://github.com/ajoberstar/grgit/releases)
5151

52-
## Simple Usage in Gradle
53-
5452
> [!IMPORTANT]
5553
> grgit **is not compatible** with Gradle's configuration cache and is **out of scope** for future work on grgit.
5654
55+
## Simple Usage in Gradle
56+
57+
> [!NOTE]
58+
> `org.ajoberstar.grgit` has poor compatibility with Kotlin scripts. See #361 for an example.
59+
5760
Apply the `org.ajoberstar.grgit` plugin in any project that needs to access a `Grgit` instance.
5861

5962
> [!NOTE]

0 commit comments

Comments
 (0)