From 4bbd81105b898aebed4f3adc7ca166b9dc7d0aad Mon Sep 17 00:00:00 2001
From: joshuaboud <joshuaboud@hotmail.com>
Date: Thu, 3 Jun 2021 14:43:03 -0300
Subject: [PATCH] add synopsis to write-chunks

---
 navigator/scripts/write-chunks.py | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/navigator/scripts/write-chunks.py b/navigator/scripts/write-chunks.py
index 79b7647..acec7e0 100755
--- a/navigator/scripts/write-chunks.py
+++ b/navigator/scripts/write-chunks.py
@@ -17,6 +17,15 @@
     along with Cockpit Navigator.  If not, see <https://www.gnu.org/licenses/>.
 """
 
+"""
+Synopsis: `write-chunks.py <newline delimited JSON objects>`
+JSON objects are of form:
+obj = {
+    seek: <byte offset>
+    chunk: <base64 encoded data chunk>
+}
+"""
+
 import base64
 import os
 import sys