Merge pull request #29 from cy6erGn0m/gradle-plugin

Gradle plugin

1 files changed, 35 insertions, 1 deletions

diff --git a/README.md b/README.md
index 68d82aab..61849bda 100644
--- a/README.md
+++ b/README.md
@@ -153,4 +153,38 @@ Configuring source links mapping
         </sourceLinks>
     </configuration>
 </plugin>
-```
\ No newline at end of file
+```
+
+### Using Gradle plugin
+
+```groovy
+buildscript {
+    repositories {
+        mavenLocal()
+        jcenter()
+    }
+    dependencies {
+        classpath "org.jetbrains.dokka:dokka-gradle-plugin:0.1-SNAPSHOT"
+    }
+}
+
+apply plugin: 'org.jetbrains.dokka'
+```
+
+To configure plugin use dokka lambda in the root scope. For example:
+
+```groovy
+dokka {
+    linkMapping {
+        dir = "src/main/kotlin"
+        url = "https://github.com/cy6erGn0m/vertx3-lang-kotlin/blob/master/src/main/kotlin"
+        suffix = "#L"
+    }
+}
+```
+
+To get it generated use gradle `dokka` task
+
+```bash
+./gradlew dokka
+```