From f221625698ccd200285a3986b72faac678d6e45f Mon Sep 17 00:00:00 2001
From: Claude <noreply@anthropic.com>
Date: Fri, 26 Jun 2026 09:44:52 +0000
Subject: [PATCH] docs: document how to check the GramFrame version

Adds a "Checking the version" section to the README covering both the Pan
button tooltip and the programmatic state.version route via the public API.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01UrV8WBAsULghxpC6j7d9J5
---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index a05b60e..47a605a 100644
--- a/README.md
+++ b/README.md
@@ -59,3 +59,18 @@ Trainees or students using sonar training manuals in HTML format.
 ## Usage
 
 Include the JavaScript file via `<script>`, and place a config table with the appropriate class on your HTML page. The component will auto-initialize after page load.
+
+## Checking the version
+
+To identify which version of GramFrame an instance is running — useful when
+reporting or debugging an issue:
+
+- **In the UI:** hover over the **Pan** button. A tooltip shows `GramFrame vX.Y.Z`.
+  (The tooltip is available even before zooming in, while the button is disabled.)
+- **Programmatically:** read `state.version` via the public API:
+  ```js
+  GramFrame.addStateListener(state => console.log(state.version))
+  ```
+
+Released builds show the real version (e.g. `v0.1.12`); local development builds
+show `vDEV` until `yarn generate-version` runs.