From b3c4292f209511e79c84dd76d42355baa04e16ba Mon Sep 17 00:00:00 2001
From: Sergey Mashkov <sergey.mashkov@jetbrains.com>
Date: Fri, 10 Jul 2015 15:51:59 +0300
Subject: Maven plugin getting started

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 7722b8ca3..68d82aab6 100644
--- a/README.md
+++ b/README.md
@@ -106,3 +106,51 @@ Build dokka and install maven plugin (do not require maven installed)
 ```bash
 ant build-and-install
 ```
+
+### Using Maven plugin
+
+Minimal maven configuration is
+
+```xml
+<plugin>
+    <groupId>org.jetbrains.dokka</groupId>
+    <artifactId>dokka-maven-plugin</artifactId>
+    <version>${dokka.version}</version>
+    <executions>
+        <execution>
+            <phase>pre-site</phase>
+            <goals>
+                <goal>dokka</goal>
+            </goals>
+        </execution>
+    </executions>
+</plugin>
+```
+
+by default files will be generated in `target/dokka`
+
+Configuring source links mapping
+
+```xml
+<plugin>
+    <groupId>org.jetbrains.dokka</groupId>
+    <artifactId>dokka-maven-plugin</artifactId>
+    <version>${dokka.version}</version>
+    <executions>
+        <execution>
+            <phase>pre-site</phase>
+            <goals>
+                <goal>dokka</goal>
+            </goals>
+        </execution>
+    </executions>
+    <configuration>
+        <sourceLinks>
+            <link>
+                <dir>${project.basedir}/src/main/kotlin</dir>
+                <url>http://github.com/me/myrepo</url>
+            </link>
+        </sourceLinks>
+    </configuration>
+</plugin>
+```
\ No newline at end of file
-- 
cgit v1.2.3