From 902c660a10e654ebc96e40cfab7d09d36b7a77ac Mon Sep 17 00:00:00 2001
From: Paul Oliver <contact@pauloliver.dev>
Date: Sat, 21 Mar 2026 01:36:24 +0100
Subject: Adds data server

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

(limited to 'README.md')

diff --git a/README.md b/README.md
index a012fdc..ed71495 100644
--- a/README.md
+++ b/README.md
@@ -62,6 +62,26 @@ removed, you can reload the saved simulation with the following command:
 user@host$ ./salis.py load -n world-1 -o
 ```
 
+## Data Server
+
+![SALIS data server](data.png)
+*SALIS data server*
+
+This project includes a web visualizer that plots live simulation data. A generic
+set of plots is configured by default for all VM architectures. Each architecture
+may expand on these by configuring its own set of plots. Once a simulation has been
+created (i.e., exists in `${HOME}/.salis`), you may launch the data server with:
+```console
+user@host$ ./salis.py serve -n world-1
+```
+
+You should then be able to access the server at `http://localhost:8080`. The data
+server may run regardless of whether the associated simulation is running or not.
+
+> NOTE: this server implementation is very minimal and has no built-in security.
+> Please do not put this on the internet! Only run the data server within secure
+> networks that you own.
+
 ## Requirements
 - C compiler
 - Python
-- 
cgit v1.2.1