aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKamil Doległo <kamilok1965@interia.pl>2019-03-19 11:50:06 +0100
committerSimon Ogorodnik <Simon.Ogorodnik@jetbrains.com>2019-03-19 20:52:07 +0300
commit6a1a0fde56be22c565d10d71f37f84e8d78c212a (patch)
tree1563a33718b996ca51e995b206e310d789ae1560 /README.md
parentfd2f36301e95f8d100e1c2b942f1590144d8c6c2 (diff)
downloaddokka-6a1a0fde56be22c565d10d71f37f84e8d78c212a.tar.gz
dokka-6a1a0fde56be22c565d10d71f37f84e8d78c212a.tar.bz2
dokka-6a1a0fde56be22c565d10d71f37f84e8d78c212a.zip
Update readme for 0.9.18
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 20 insertions, 4 deletions
diff --git a/README.md b/README.md
index 34b01f54..1d62a4ed 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()
+}
apply plugin: 'org.jetbrains.dokka'
```
+or using the new plugins block:
+
+```groovy
+plugins {
+ id 'org.jetbrains.dokka' version '0.9.18'
+}
+repositories {
+ jcenter()
+}
+```
+
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'