From 1ce1ae95fef110f88806cd55ad0971891cd134c5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bart=C5=82omiej=20Przemys=C5=82aw=20Pluta?=
 <noreply.git@mx.bartlomiejpluta.com>
Date: Sun, 31 May 2020 16:51:43 +0200
Subject: [PATCH] Update help and README

---
 README.md                          | 15 ++++++++++++++-
 app/src/main/assets/help/help.html | 20 ++++++++++++++++++--
 2 files changed, 32 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 306dfd3..b55b8eb 100644
--- a/README.md
+++ b/README.md
@@ -91,4 +91,17 @@ served through the `/sonos/{fileName}` endpoint and Sonos device is requested to
 change its source stream URL to this file. The already generated files are stored in cache
 directory so there is no need to resynthesize frequently-used message which reduces
 the overall time needed to complete the request. You are still able to invalidate
-this cache via application settings.
\ No newline at end of file
+this cache via application settings.
+
+
+## The `/gong.wav` endpoint
+```
+GET /gong.wav
+```
+*Returns:* `200 OK` with gong wave file (`Content-Type: audio/x-wav`)
+
+This endpoint is designed for serving gong wave to Sonos devices
+and &ndash; similar to `/sonos/{fileName}` &ndash; is not intended
+to be used directly by you. If gong is enabled in the settings,
+Sonos is requested to change its source stream URL to a gong
+file prior to the actual announcement being served by `/sonos/{fileName}` endpoint.
diff --git a/app/src/main/assets/help/help.html b/app/src/main/assets/help/help.html
index cb6afb7..aa7638e 100644
--- a/app/src/main/assets/help/help.html
+++ b/app/src/main/assets/help/help.html
@@ -53,8 +53,8 @@ POST /say
 <p><b>Returns:</b> <code>200 OK</code> with empty body</p>
 <p>
     The <code>/say</code> endpoint allows you to perform TTS task using device's speakers or the
-    external ones connected to it via jack, Bluetooth etc. For example if you have some 
-    old PC-speakers you are able to connect your device to them via line port and 
+    external ones connected to it via jack, Bluetooth etc. For example if you have some
+    old PC-speakers you are able to connect your device to them via line port and
     get a complete speech-based notification system.
 </p>
 
@@ -111,5 +111,21 @@ GET /sonos/{fileName}
     the overall time needed to complete the request. You are still able to invalidate
     this cache via application settings.
 </p>
+
+<h2>The <code>/gong.wav</code> endpoint</h2>
+<pre>
+GET /gong.wav
+</pre>
+<p>
+    <b>Returns: </b> <code>200 OK</code>
+    with gong wave file (<code>Content-Type: audio/x-wav</code>)
+</p>
+<p>
+    This endpoint is designed for serving gong wave file
+    to Sonos devices and &ndash; similar to <code>/sonos/{fileName}</code> &ndash;
+    is not intended to be used directly by you. If gong is enabled in the settings,
+    Sonos is requested to change its source stream URL to a gong file prior to
+    the actual announcement being served by <code>/sonos/{fileName}</code> endpoint.
+</p>
 </body>
 </html>
\ No newline at end of file