From e9f401da2e3b87327e7c265892f7be874f1e9d94 Mon Sep 17 00:00:00 2001
From: Brian Norman <brian@bnorm.com>
Date: Thu, 6 Feb 2020 11:36:56 -0600
Subject: [PATCH] Include directions on how to enable compiling with IR

---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/README.md b/README.md
index 985a359cec6..311d60e420c 100644
--- a/README.md
+++ b/README.md
@@ -49,6 +49,20 @@ assert(hello.length == "World".substring(1, 4).length)
 	at <stacktrace>
 ```
 
+## Kotlin IR
+
+Using this compiler plugin only works if the code is compiled using IR. This can
+only be enabled when compiling the test SourceSet if desired. As Kotlin IR is
+still experimental, mileage may vary.
+
+```groovy
+compileTestKotlin {
+    kotlinOptions {
+        useIR = true
+    }
+}
+```
+
 ## Project Snapshots
 
 Snapshot builds are available through Sonatype Snapshot repository.