From 1e008f284183eef0bba1605f9e0605cb5bb0be3b Mon Sep 17 00:00:00 2001
From: Arik Sosman <git@arik.io>
Date: Thu, 21 Nov 2024 09:09:29 -0800
Subject: [PATCH] Add demo server and timestamp usage documentation

---
 README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/README.md b/README.md
index 1210490..eec2286 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,28 @@ gossip data.
 
 These are the components it's comprised of.
 
+## Demo Server
+
+To experiment with a local instance of the RGS server, navigate to the cache directory specified using
+the `RAPID_GOSSIP_SYNC_SERVER_CACHES_PATH` environment variable (`./res` by default) and therein to the `symlinks`
+subdirectory:
+
+```
+<cache_path>/symlinks
+```
+
+From there, simply run:
+
+```shell
+python3 -m http.server 8011
+```
+
+The snapshots will be accessible via `http://localhost:8011/{timestamp}.bin`. The first timestamp value should be 0,
+and subsequent timestamps will be extracted from the snapshots themselves by the RGS client.
+
+Note that this is pretty much the same functionality you would need in a production environment, except hopefully using
+something more robust than Python's `http.server` module.
+
 ## Modules
 
 ### config