aboutsummaryrefslogtreecommitdiff
path: root/subprojects/analysis-kotlin-api/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'subprojects/analysis-kotlin-api/README.md')
-rw-r--r--subprojects/analysis-kotlin-api/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/subprojects/analysis-kotlin-api/README.md b/subprojects/analysis-kotlin-api/README.md
new file mode 100644
index 00000000..5b03b297
--- /dev/null
+++ b/subprojects/analysis-kotlin-api/README.md
@@ -0,0 +1,10 @@
+# Analysis: Kotlin API
+
+Public API for interacting with Kotlin analysis, regardless of implementation. Contains no business logic.
+
+Can be used to request additional information about Kotlin declarations.
+
+Has to be used as a `compileOnly` dependency as Dokka bundles it by default in all runners.
+
+The actual implementation (K1/K2/etc) will be resolved and bootstrapped during runtime, so the
+user must not think about it.