From 5eeb2bbeb8c71ae813808ee0e8d09293c4abe1c1 Mon Sep 17 00:00:00 2001
From: Ignat Beresnev <ignat.beresnev@jetbrains.com>
Date: Thu, 19 Jan 2023 04:10:57 +0100
Subject: Revise README documentation for examples and plugins (#2736)

---
 examples/maven/README.md | 11 +++++++++++
 examples/maven/pom.xml   |  3 +++
 2 files changed, 14 insertions(+)
 create mode 100644 examples/maven/README.md

(limited to 'examples/maven')

diff --git a/examples/maven/README.md b/examples/maven/README.md
new file mode 100644
index 00000000..766b80fd
--- /dev/null
+++ b/examples/maven/README.md
@@ -0,0 +1,11 @@
+# Dokka Maven example
+
+This example demonstrates how you can configure Dokka in a Maven-based project.
+
+### Running
+
+Run the `dokka:dokka` goal to generate documentation for this example:
+
+```bash
+mvn dokka:dokka
+```
diff --git a/examples/maven/pom.xml b/examples/maven/pom.xml
index 74675d6d..7c9de827 100644
--- a/examples/maven/pom.xml
+++ b/examples/maven/pom.xml
@@ -68,6 +68,9 @@
                             <lineSuffix>#L</lineSuffix>
                         </link>
                     </sourceLinks>
+                    <includes>
+                        <include>Module.md</include>
+                    </includes>
                 </configuration>
             </plugin>
         </plugins>
-- 
cgit