From 9c28f0008928e9b31b25c787ddc5ff09fe70af03 Mon Sep 17 00:00:00 2001 From: Kamil Doległo Date: Tue, 16 Apr 2019 16:52:34 +0200 Subject: cherrypick readme update --- README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f47f1936..bf69a393 100644 --- a/README.md +++ b/README.md @@ -16,17 +16,32 @@ buildscript { repositories { jcenter() } - dependencies { classpath "org.jetbrains.dokka:dokka-gradle-plugin:${dokka_version}" } } +repositories { + jcenter() // or maven { url 'https://dl.bintray.com/kotlin/dokka' } +} apply plugin: 'org.jetbrains.dokka' ``` +or using the new plugins block: + +```groovy +plugins { + id 'org.jetbrains.dokka' version '0.9.18' +} +repositories { + jcenter() // or maven { url 'https://dl.bintray.com/kotlin/dokka' } +} +``` + The plugin adds a task named "dokka" to the project. +If you encounter any problems when migrating from older versions of Dokka, please see the [FAQ](https://github.com/Kotlin/dokka/wiki/faq). + Minimal dokka configuration: ```groovy @@ -180,7 +195,7 @@ dependencies { ``` #### FAQ -Please see the [FAQ](https://github.com/Kotlin/dokka/wiki/faq). +If you encounter any problems, please see the [FAQ](https://github.com/Kotlin/dokka/wiki/faq). #### Android @@ -192,12 +207,13 @@ buildscript { repositories { jcenter() } - dependencies { classpath "org.jetbrains.dokka:dokka-android-gradle-plugin:${dokka_version}" } } - +repositories { + jcenter() +} apply plugin: 'com.android.library' apply plugin: 'kotlin-android' apply plugin: 'org.jetbrains.dokka-android' -- cgit