From 21243e6cfb8c185d1c0fb39805d92618e0e053a3 Mon Sep 17 00:00:00 2001
From: Valentin Brandl <vbrandl@riseup.net>
Date: Sun, 16 Jun 2019 15:00:46 +0200
Subject: [PATCH] Document JSON endpoint on index page

---
 templates/index.rs.html | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/templates/index.rs.html b/templates/index.rs.html
index 366447a..5d23dd2 100644
--- a/templates/index.rs.html
+++ b/templates/index.rs.html
@@ -45,6 +45,21 @@ would render this badge:
 alt="example badge" /></a>
 </pre>
 
+<p>
+You can also request the HoC as JSON by appending <code>/json</code> to the request path. This will return a JSON
+object with two fields: <code>count</code> and <code>head</code> with count being the HoC value and head being the
+commit ref of <code>HEAD</code>. Requesting
+<a href="https://@domain/github/vbrandl/hoc/json">https://@domain/github/vbrandl/hoc/json</a> might return something
+along the lines of
+</p>
+
+<pre>
+&#123;
+    "head" : "05736ee3ba256ec9a7227c436aef2bf43db109ab",
+    "count": 7582
+&#125;
+</pre>
+
 <h2>Badge Generator</h2>
 
 <form method="post" action="/generate">