aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorsebastian.sellmair <sebastian.sellmair@jetbrains.com>2020-08-25 15:47:11 +0200
committerPaweł Marks <Kordyjan@users.noreply.github.com>2020-08-25 16:20:30 +0200
commit219e2c98f5d03fc8581fd6ce9dd870919523be44 (patch)
treefd88a8ea37d3e8429af925cb5e589fdccacb7bb4 /README.md
parent3724b1bbaf488de7b0b27214c99e570ca7f570e0 (diff)
downloaddokka-219e2c98f5d03fc8581fd6ce9dd870919523be44.tar.gz
dokka-219e2c98f5d03fc8581fd6ce9dd870919523be44.tar.bz2
dokka-219e2c98f5d03fc8581fd6ce9dd870919523be44.zip
Add note to migration guide to README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7e4a755d..19aff3b6 100644
--- a/README.md
+++ b/README.md
@@ -51,6 +51,8 @@ kotlin { // Kotlin plugin configuration
```
### Using the Gradle plugin
+_Note: If you are upgrading from 0.10.x to a current release of dokka, please have a look at our
+[migration guide](runners/gradle-plugin/MIGRATION.md)_
The preferred way is to use `plugins` block. Since dokka is currently not published to the Gradle plugin portal,
you not only need to add `dokka` to the `build.gradle.kts` file, but you also need to modify the `settings.gradle.kts` file: