Skip to content

Commit

Permalink
chore: Document Kotlin issue
Browse files Browse the repository at this point in the history
Fixes #361
  • Loading branch information
ajoberstar committed Oct 5, 2024
1 parent 41046ec commit afbc737
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down

0 comments on commit afbc737

Please sign in to comment.