Skip to content

docs: document how to check the GramFrame version #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
IanMayo merged 1 commit into from
Jun 26, 2026
Merged

docs: document how to check the GramFrame version #182

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Loading