From: David ‘Bombe’ Roden <bombe@pterodactylus.net>
Date: Thu, 15 Sep 2011 16:28:39 +0000 (+0200)
Subject: Add short documentation to index page.
X-Git-Tag: 0.0.2^2~2
X-Git-Url: https://git.pterodactylus.net/?a=commitdiff_plain;h=3693c0206a1b4d43e73a43c30d52a7f564f4ba0b;p=WoTNS.git

Add short documentation to index page.
---

diff --git a/src/main/resources/templates/index.html b/src/main/resources/templates/index.html
index 2144e2f..84817ae 100644
--- a/src/main/resources/templates/index.html
+++ b/src/main/resources/templates/index.html
@@ -1,6 +1,13 @@
 <%include include/head.html>
 <h1>WoTNS</h1>
-<p>Yay, Index!</p>
+<p>The Web of Trust Service uses properties of Web of Trust identities to implement a DNS-like scheme on top of Freenet.</p>
+<p>The general syntax is: <code>http://<%request.host>/tns/<i>identity</i>/<i>target</i></code>.</p>
+<p><i>identity</i> is the nickname of a Web of Trust identity, such as “Bombe”. It is also possible to include the beginning of the identity’s
+key into <i>identity</i>, in the form of <i>nickname@start-of-key</i>, such as “Bombe@e3my”.</p>
+<p>The <i>target</i> consists of a name chosen by the remote identity. It can consist of latin latters, digits, and periods (and the final name
+has to fulfill the Web of Trust’s requirement for a valid property name.</p>
+<p>To be able to add targets for one of your identities, you first have to create an identity using the <a href="/WebOfTrust/">Web of Trust</a>,
+and you have to enable the identity here.</p>
 
 <%foreach enabledIdentities identity>
 	<%first>