From ff9cd0f33a5a3bb6749f10a10a013a09548e71a9 Mon Sep 17 00:00:00 2001
From: Henri Bergius <henri.bergius@iki.fi>
Date: Mon, 9 Dec 2024 13:39:22 +0000
Subject: [PATCH] Quick docs

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

diff --git a/README.md b/README.md
index 72c8e48..e31ae44 100644
--- a/README.md
+++ b/README.md
@@ -2,3 +2,12 @@ Contextual information display for Signal K
 ===========================================
 
 This is an adaptation of the [c-base infoscreens system](https://github.com/c-base/infoscreens) for Signal K. The idea is to enable HTML-capable viewers (like a kiosk display) to show different dashboards depending on whether the boat is sailing, at anchor, etc. This works well for instance with an onboard [Grafana](https://grafana.com/) installation.
+
+<img width="886" alt="Screenshot 2024-12-09 at 13 37 06" src="https://github.com/user-attachments/assets/bbcfa2ea-19c5-47a0-a90d-e38122fca3d4">
+
+## Usage
+
+Configure the plugin and set URLs for the different navigation states:
+<img width="735" alt="Screenshot 2024-12-09 at 13 38 00" src="https://github.com/user-attachments/assets/b61fe6d4-e47b-49bb-8a2e-5aeea649b769">
+
+Point your kiosk browser to the webapp URL supplied by this plugin (`/@meri-imperiumi/signalk-infodisplay/` on your Signal K server.