drime

commit 80fa11fa3764e99020a7dedaf90e32f323f0ca0c
parent b471dbdd7b0946d8cd09d033f5e1f622ef029595
Author: Antoine Amarilli <a3nm@a3nm.net>
Date:   Tue, 27 Dec 2011 16:16:42 +0100

document the api

Diffstat:
templates/about.html
 | 
7
+++++++

1 file changed, 7 insertions(+), 0 deletions(-)
diff --git a/templates/about.html b/templates/about.html
@@ -68,6 +68,10 @@ non une prononciation poétique. Par exemple, "placement" est référencé comme
 "plasmA~" but serait "plas@mA~"). Des heuristiques sont utilisées afin de
 compenser ça lorsque les résultats sont filtrés sur le nombre de syllabes.</p>
 
+<h2>Y a-t-il une API&nbsp;?</h2>
+<p>Plus ou moins. Fournissez un paramètre GET "json" et vous obtiendrez la page
+en JSON.</p>
+
 <h2>D'où vient le nom&nbsp;?</h2>
 
 <p>Ça se prononce [dRim]. C'est une abréviation de "dictionnaire de rimes", et
@@ -137,6 +141,9 @@ versify (for instance, "placement" is reported as "plasmA~" but would be read as
 "plas@mA~"). Heuristics are used to work around this when filtering on the
 number of syllables.</p>
 
+<h2>Is there an API?</h2>
+<p>Sort of. Provide a "json" GET parameter and you'll get the page in JSON.</p>
+
 <h2>What about the name?</h2>
 
 <p>It's pronounced [dRim], as a pun with "dream" (the dream rhyme dictionary)