Added information about the linked project

[maven-thymeleaf-skin] / src / site / xhtml / index.xhtml
diff --git a/src/site/xhtml/index.xhtml b/src/site/xhtml/index.xhtml

index 524a997..d5b7445 100644 (file)
--- a/src/site/xhtml/index.xhtml
+++ b/src/site/xhtml/index.xhtml
@@ -6,10 +6,43 @@
   <body>
    <h1>${project.name}</h1>
    <h2>${project.description}</h2>
-  <p><em>TODO...</em></p>
+  <p>
+    The Apache-Maven Thymeleaf-Skin is an Apache Maven site skin, aimed at
+    giving you <strong>full freedom in styling and structuring</strong>
+    your website, while using the comfortable mechanisms provided by maven
+    to build the documentation of your projects.
+  </p>
+  <p>
+    To achieve this gloal, this skin renders very plain (x)html5 pages, that
+    call a thymelaf layout-template, to give you full control over the
+    decoration of the pages.
+    The skin compiles all available information about the pages, like the
+    position of the page in the menu-structure, the according breadcrumb-path
+    and configured meta-information (an additional title, image and
+    alternative text for the image) of the link in the menu.
+    These information is made available to the called template as a
+    JSON-string.
+    Your template may parse this string and use the information to render a
+    custom menu and other navigation-elements like a breadcrumb-path.
+  </p>
+  <p>
+    See the <a href="usage.html">usage-page</a> for a full explanation, on
+    how to use the skin.
+  </p>
+  <p>
+    This skin was developed as a part of the project
+    <a href="http://yourshouter.com/projekte/crowdgest%C3%BCtzte-veranstaltungs-suchmaschine.html">Entwicklung einer crowdgestützten Suchmaschine für Veranstaltungs- und Locationdaten</a>,
+    to ease the process of publishing the project results.
+    As one of the winners of the
+    <a href="http://yourshouter.com/referenzen/leitmarktwettbewerb-createmedia-nrw.html">CreateMedia.NRW</a>-contest,
+    the project is promoted by the
+    <a href="http://yourshouter.com/partner/mweimh-nrw.html">ministerium for economy, energy, industry, medium-sized bussinesses and handcraft for the state of North-Rhine Westphalia</a>
+    in the course of the
+    <a href="http://yourshouter.com/partner/efre--europ%C3%A4ischer-fonds-f%C3%BCr-regionale-entwicklung.html">OP EFRE.NRW 2014 — 2020</a>.
+  </p>
    <h2>Releases</h2>
    <ul>
-    <li><a href="http://juplo.de/maven-thymeleaf-skin/">current version</a></li>
+    <li><a href="index.html">current version</a></li>
      <li>${project.version} (this version)</li>
    </ul>
   </body>