@teachinglab/omd 0.6.1 → 0.6.3

package/npm-docs/api/omdBinaryExpressionNode.md

@@ -1,86 +1,86 @@
-# omdBinaryExpressionNode
-
-Represents a binary operation in a mathematical expression, such as addition (`a + b`), subtraction, multiplication, or division. This node is a cornerstone of the expression tree, containing a left operand, a right operand, and an operator.
-
-## Class Definition
-
-```javascript
-export class omdBinaryExpressionNode extends omdNode
-```
-
-## Constructor
-
-### `new omdBinaryExpressionNode(ast)`
-
-Creates a new `omdBinaryExpressionNode` instance.
-
--   **`ast`** (`object`): The abstract syntax tree (AST) node from a parser like math.js. It must contain:
-    -   `args`: An array with at least two operand nodes.
-    -   `op`: The operator symbol (e.g., `+`, `*`).
-    -   `fn`: The function name for the operation (e.g., `add`, `multiply`).
-    -   `implicit` (`boolean`, optional): `true` if the multiplication is implicit (e.g., `2x`).
-
-During construction, the node automatically handles a critical piece of mathematical convention: **implicit multiplication**. Based on the configuration in `omdConfigManager`, it will:
-
-1.  **Reorder Operands**: If it encounters an expression like `x * 2`, it will automatically reorder it to the conventional `2 * x` by swapping the left and right child nodes.
-2.  **Determine Implicit Form**: It checks if the combination of operands (e.g., a constant and a variable) should be represented implicitly. If so, it removes the visible operator (`*`) and marks the node as implicit.
-
-## Public Properties
-
--   **`left`** ([`omdNode`](./omdNode.md)): The node representing the left-hand side of the operation.
--   **`right`** ([`omdNode`](./omdNode.md)): The node representing the right-hand side of the operation.
--   **`op`** ([`omdOperatorNode`](./omdOperatorNode.md) | `null`): The node for the operator. This is `null` for implicit multiplication.
--   **`operation`** (`string`): The name of the mathematical function (e.g., `'add'`, `'multiply'`).
--   **`isImplicit`** (`boolean`): `true` if the node represents implicit multiplication.
-
-## Public Methods
-
-### `clone()`
-
-Creates a deep, recursive clone of the node, including its children (`left`, `right`, `op`). The new node's `provenance` property will link back to the ID of this original node.
-
--   **Returns**: A new `omdBinaryExpressionNode` instance.
-
-### `evaluate(variables)`
-
-Recursively evaluates the expression and returns the numerical result.
-
--   **`variables`** (`object`, optional): A map of variable names to their numeric values (e.g., `{ x: 5 }`).
--   **Returns**: `number` - The result of the calculation.
--   **Throws**: An `Error` for unsupported operations or division by zero.
-
-### `needsParentheses()`
-
-Determines if this expression needs to be wrapped in parentheses to maintain the correct order of operations when it is a child of another binary expression.
-
--   **Returns**: `boolean` - `true` if parentheses are required.
-
-### `setHighlight(highlightOn, color)`
-
-Applies or removes a highlight from the node and all of its children (left, right, and operator).
-
--   **`highlightOn`** (`boolean`): `true` to highlight, `false` to remove.
--   **`color`** (`string`, optional): The color of the highlight.
-
-### `clearProvenanceHighlights()`
-
-Recursively clears all provenance-related highlights from this node and its children.
-
-### `toMathJSNode()`
-
-Converts the node back into a math.js-compatible AST format.
-
--   **Returns**: `object` - A math.js OperatorNode.
-
-### `toString()`
-
-Converts the node into a human-readable string, automatically handling parentheses for precedence.
-
--   **Returns**: `string` - The string representation of the expression.
-
-## Internal Methods
-
--   **`_shouldUseImplicitMultiplication(left, right)`**: Checks the configuration to decide if implicit multiplication is appropriate for the given operand types.
--   **`_shouldReorderMultiplication(left, right)`**: Determines if operands should be swapped to follow convention (e.g., `variable * constant` -> `constant * variable`).
--   **`computeDimensions()`**: Calculates the bounding box of the expression.
--   **`updateLayout()`**: Positions the left operand, operator, and right operand correctly, aligning them along their baseline.
+# omdBinaryExpressionNode
+
+Represents a binary operation in a mathematical expression, such as addition (`a + b`), subtraction, multiplication, or division. This node is a cornerstone of the expression tree, containing a left operand, a right operand, and an operator.
+
+## Class Definition
+
+```javascript
+export class omdBinaryExpressionNode extends omdNode
+```
+
+## Constructor
+
+### `new omdBinaryExpressionNode(ast)`
+
+Creates a new `omdBinaryExpressionNode` instance.
+
+-   **`ast`** (`object`): The abstract syntax tree (AST) node from a parser like math.js. It must contain:
+    -   `args`: An array with at least two operand nodes.
+    -   `op`: The operator symbol (e.g., `+`, `*`).
+    -   `fn`: The function name for the operation (e.g., `add`, `multiply`).
+    -   `implicit` (`boolean`, optional): `true` if the multiplication is implicit (e.g., `2x`).
+
+During construction, the node automatically handles a critical piece of mathematical convention: **implicit multiplication**. Based on the configuration in `omdConfigManager`, it will:
+
+1.  **Reorder Operands**: If it encounters an expression like `x * 2`, it will automatically reorder it to the conventional `2 * x` by swapping the left and right child nodes.
+2.  **Determine Implicit Form**: It checks if the combination of operands (e.g., a constant and a variable) should be represented implicitly. If so, it removes the visible operator (`*`) and marks the node as implicit.
+
+## Public Properties
+
+-   **`left`** ([`omdNode`](./omdNode.md)): The node representing the left-hand side of the operation.
+-   **`right`** ([`omdNode`](./omdNode.md)): The node representing the right-hand side of the operation.
+-   **`op`** ([`omdOperatorNode`](./omdOperatorNode.md) | `null`): The node for the operator. This is `null` for implicit multiplication.
+-   **`operation`** (`string`): The name of the mathematical function (e.g., `'add'`, `'multiply'`).
+-   **`isImplicit`** (`boolean`): `true` if the node represents implicit multiplication.
+
+## Public Methods
+
+### `clone()`
+
+Creates a deep, recursive clone of the node, including its children (`left`, `right`, `op`). The new node's `provenance` property will link back to the ID of this original node.
+
+-   **Returns**: A new `omdBinaryExpressionNode` instance.
+
+### `evaluate(variables)`
+
+Recursively evaluates the expression and returns the numerical result.
+
+-   **`variables`** (`object`, optional): A map of variable names to their numeric values (e.g., `{ x: 5 }`).
+-   **Returns**: `number` - The result of the calculation.
+-   **Throws**: An `Error` for unsupported operations or division by zero.
+
+### `needsParentheses()`
+
+Determines if this expression needs to be wrapped in parentheses to maintain the correct order of operations when it is a child of another binary expression.
+
+-   **Returns**: `boolean` - `true` if parentheses are required.
+
+### `setHighlight(highlightOn, color)`
+
+Applies or removes a highlight from the node and all of its children (left, right, and operator).
+
+-   **`highlightOn`** (`boolean`): `true` to highlight, `false` to remove.
+-   **`color`** (`string`, optional): The color of the highlight.
+
+### `clearProvenanceHighlights()`
+
+Recursively clears all provenance-related highlights from this node and its children.
+
+### `toMathJSNode()`
+
+Converts the node back into a math.js-compatible AST format.
+
+-   **Returns**: `object` - A math.js OperatorNode.
+
+### `toString()`
+
+Converts the node into a human-readable string, automatically handling parentheses for precedence.
+
+-   **Returns**: `string` - The string representation of the expression.
+
+## Internal Methods
+
+-   **`_shouldUseImplicitMultiplication(left, right)`**: Checks the configuration to decide if implicit multiplication is appropriate for the given operand types.
+-   **`_shouldReorderMultiplication(left, right)`**: Determines if operands should be swapped to follow convention (e.g., `variable * constant` -> `constant * variable`).
+-   **`computeDimensions()`**: Calculates the bounding box of the expression.
+-   **`updateLayout()`**: Positions the left operand, operator, and right operand correctly, aligning them along their baseline.

package/npm-docs/api/omdCanvas.md

@@ -1,84 +1,84 @@
-# omdCanvas
-
-The `omdCanvas` class is the core component for creating and managing an interactive 2D drawing surface. It provides the primary API for all canvas operations, including drawing and managing strokes, handling user input, and orchestrating various features like tools, a toolbar, and focus frames.
-
-## Class Definition
-
-```javascript
-export class omdCanvas
-```
-
-## Constructor
-
-### `new omdCanvas(container, [options])`
-
-Creates a new `omdCanvas` instance within a specified container element.
-
--   **`container`** (`HTMLElement` | `string`): The HTML element or a CSS selector string for the container where the canvas will be rendered. Throws an error if the container is not found.
--   **`options`** (`object`, optional): Configuration options for the canvas. These are passed to the `CanvasConfig` class. See the [Configuration Options](./configuration-options.md) for details.
-
-## Properties
-
--   **`container`** (`HTMLElement`): The HTML container element for the canvas.
--   **`config`** (`CanvasConfig`): The configuration object for the canvas.
--   **`svg`** (`SVGElement`): The main `<svg>` element that serves as the drawing surface.
--   **`backgroundLayer`** (`SVGGElement`): An SVG group (`<g>`) for background elements like the grid.
--   **`drawingLayer`** (`SVGGElement`): The SVG group where all drawing strokes are rendered.
--   **`uiLayer`** (`SVGGElement`): The SVG group for UI elements that overlay the drawing, such as selection boxes.
--   **`focusFrameLayer`** (`SVGGElement`): The SVG group dedicated to holding `FocusFrame` elements.
--   **`strokes`** (`Map<string, Stroke>`): A map of all stroke objects on the canvas, with their unique IDs as keys.
--   **`selectedStrokes`** (`Set<string>`): A set of the IDs of all currently selected strokes.
--   **`toolManager`** (`ToolManager`): The instance managing the active drawing tools (Pencil, Eraser, etc.).
--   **`eventManager`** (`EventManager`): The instance managing all user input events.
--   **`cursor`** (`Cursor`): The instance that manages the custom cursor's appearance and behavior.
--   **`toolbar`** (`Toolbar`): The UI toolbar for tool selection (if enabled in config).
--   **`focusFrameManager`** (`FocusFrameManager`): The instance managing focus frames (if enabled in config).
-
-## Public Methods
-
-### Stroke Management
-
--   **`addStroke(stroke)`**: Adds a `Stroke` object to the canvas and renders it. Emits `strokeAdded`.
--   **`removeStroke(strokeId)`**: Removes a stroke from the canvas by its ID. Emits `strokeRemoved`.
--   **`clear()`**: Removes all strokes from the canvas. Emits `cleared`.
-
-### Selection
-
--   **`selectStrokes(strokeIds)`**: Programmatically selects a set of strokes by their IDs. Emits `selectionChanged`.
-
-### Coordinate Conversion
-
--   **`clientToSVG(clientX, clientY)`**: Converts screen coordinates (e.g., from a mouse event) to the canvas's local SVG coordinate system.
-    -   **Returns**: `{ x, y }` object.
-
-### Exporting
-
--   **`exportSVG()`**: Exports the canvas drawing as a clean SVG string. UI layers (`uiLayer`, `focusFrameLayer`) are excluded.
--   **`async exportImage([format], [quality])`**: Exports the canvas as a bitmap image.
-    -   **`format`** (`string`): `'png'`, `'jpeg'`, or `'webp'`. Default: `'png'`.
-    -   **`quality`** (`number`): For JPEG/WebP, a value from 0 to 1. Default: `1`.
-    -   **Returns**: `Promise<Blob>` that resolves with the image data.
-
-### Canvas Management
-
--   **`resize(width, height)`**: Resizes the canvas. Emits `resized`.
--   **`toggleGrid()`**: Toggles the visibility of the background grid.
--   **`getInfo()`**: Returns an object with status information (dimensions, stroke count, active tool, etc.).
--   **`destroy()`**: Completely removes the canvas and all associated managers, event listeners, and DOM elements. Emits `destroyed`.
-
-### Event Handling (Pub/Sub)
-
--   **`on(event, callback)`**: Registers a listener for a custom canvas event.
--   **`off(event, callback)`**: Removes a previously registered event listener.
--   **`emit(event, [data])`**: Dispatches a custom event to all registered listeners.
-
-## Emitted Events
-
-The `omdCanvas` is an event emitter. You can listen for these events using the `on()` method.
-
--   `strokeAdded`, `strokeRemoved`, `cleared`: Fired for stroke operations.
--   `selectionChanged`: Fired when the set of selected strokes changes.
--   `resized`: Fired when the canvas dimensions change.
--   `pointerDown`, `pointerMove`, `pointerUp`, etc.: Raw input events, normalized by the `EventManager`.
--   `focusFrameCreated`, `focusFrameRemoved`, etc.: Events from the `FocusFrameManager`.
+# omdCanvas
+
+The `omdCanvas` class is the core component for creating and managing an interactive 2D drawing surface. It provides the primary API for all canvas operations, including drawing and managing strokes, handling user input, and orchestrating various features like tools, a toolbar, and focus frames.
+
+## Class Definition
+
+```javascript
+export class omdCanvas
+```
+
+## Constructor
+
+### `new omdCanvas(container, [options])`
+
+Creates a new `omdCanvas` instance within a specified container element.
+
+-   **`container`** (`HTMLElement` | `string`): The HTML element or a CSS selector string for the container where the canvas will be rendered. Throws an error if the container is not found.
+-   **`options`** (`object`, optional): Configuration options for the canvas. These are passed to the `CanvasConfig` class. See the [Configuration Options](./configuration-options.md) for details.
+
+## Properties
+
+-   **`container`** (`HTMLElement`): The HTML container element for the canvas.
+-   **`config`** (`CanvasConfig`): The configuration object for the canvas.
+-   **`svg`** (`SVGElement`): The main `<svg>` element that serves as the drawing surface.
+-   **`backgroundLayer`** (`SVGGElement`): An SVG group (`<g>`) for background elements like the grid.
+-   **`drawingLayer`** (`SVGGElement`): The SVG group where all drawing strokes are rendered.
+-   **`uiLayer`** (`SVGGElement`): The SVG group for UI elements that overlay the drawing, such as selection boxes.
+-   **`focusFrameLayer`** (`SVGGElement`): The SVG group dedicated to holding `FocusFrame` elements.
+-   **`strokes`** (`Map<string, Stroke>`): A map of all stroke objects on the canvas, with their unique IDs as keys.
+-   **`selectedStrokes`** (`Set<string>`): A set of the IDs of all currently selected strokes.
+-   **`toolManager`** (`ToolManager`): The instance managing the active drawing tools (Pencil, Eraser, etc.).
+-   **`eventManager`** (`EventManager`): The instance managing all user input events.
+-   **`cursor`** (`Cursor`): The instance that manages the custom cursor's appearance and behavior.
+-   **`toolbar`** (`Toolbar`): The UI toolbar for tool selection (if enabled in config).
+-   **`focusFrameManager`** (`FocusFrameManager`): The instance managing focus frames (if enabled in config).
+
+## Public Methods
+
+### Stroke Management
+
+-   **`addStroke(stroke)`**: Adds a `Stroke` object to the canvas and renders it. Emits `strokeAdded`.
+-   **`removeStroke(strokeId)`**: Removes a stroke from the canvas by its ID. Emits `strokeRemoved`.
+-   **`clear()`**: Removes all strokes from the canvas. Emits `cleared`.
+
+### Selection
+
+-   **`selectStrokes(strokeIds)`**: Programmatically selects a set of strokes by their IDs. Emits `selectionChanged`.
+
+### Coordinate Conversion
+
+-   **`clientToSVG(clientX, clientY)`**: Converts screen coordinates (e.g., from a mouse event) to the canvas's local SVG coordinate system.
+    -   **Returns**: `{ x, y }` object.
+
+### Exporting
+
+-   **`exportSVG()`**: Exports the canvas drawing as a clean SVG string. UI layers (`uiLayer`, `focusFrameLayer`) are excluded.
+-   **`async exportImage([format], [quality])`**: Exports the canvas as a bitmap image.
+    -   **`format`** (`string`): `'png'`, `'jpeg'`, or `'webp'`. Default: `'png'`.
+    -   **`quality`** (`number`): For JPEG/WebP, a value from 0 to 1. Default: `1`.
+    -   **Returns**: `Promise<Blob>` that resolves with the image data.
+
+### Canvas Management
+
+-   **`resize(width, height)`**: Resizes the canvas. Emits `resized`.
+-   **`toggleGrid()`**: Toggles the visibility of the background grid.
+-   **`getInfo()`**: Returns an object with status information (dimensions, stroke count, active tool, etc.).
+-   **`destroy()`**: Completely removes the canvas and all associated managers, event listeners, and DOM elements. Emits `destroyed`.
+
+### Event Handling (Pub/Sub)
+
+-   **`on(event, callback)`**: Registers a listener for a custom canvas event.
+-   **`off(event, callback)`**: Removes a previously registered event listener.
+-   **`emit(event, [data])`**: Dispatches a custom event to all registered listeners.
+
+## Emitted Events
+
+The `omdCanvas` is an event emitter. You can listen for these events using the `on()` method.
+
+-   `strokeAdded`, `strokeRemoved`, `cleared`: Fired for stroke operations.
+-   `selectionChanged`: Fired when the set of selected strokes changes.
+-   `resized`: Fired when the canvas dimensions change.
+-   `pointerDown`, `pointerMove`, `pointerUp`, etc.: Raw input events, normalized by the `EventManager`.
+-   `focusFrameCreated`, `focusFrameRemoved`, etc.: Events from the `FocusFrameManager`.
 -   `destroyed`: Fired when the `destroy()` method has completed.

package/npm-docs/api/omdConfigManager.md

@@ -1,113 +1,113 @@
-# omdConfigManager
-
-A module for managing the configuration of the OMD library. It handles loading settings from a JSON file, providing default values, and allowing runtime modifications.
-
-## Overview
-
-The configuration is managed as a single JSON object. The system can be initialized with a path to a `omdConfig.json` file, or it will fall back to a default configuration. The manager supports both asynchronous and synchronous access to configuration values.
-
-### Default Configuration
-
-If no `omdConfig.json` is found, the following default structure is used:
-
-```json
-{
-    "multiplication": {
-        "symbol": "·",
-        "forceImplicit": false,
-        "implicitCombinations": {
-            "constantVariable": true,
-            "variableConstant": false,
-            "parenthesisAfterVariable": true,
-            "parenthesisAfterConstant": true,
-            "variableParenthesis": true,
-            "parenthesisParenthesis": true,
-            "parenthesisVariable": true,
-            "parenthesisConstant": true,
-            "variableVariable": true
-        }
-    },
-    "stepVisualizer": {
-        "dotSizes": {
-            "level0": 8,
-            "level1": 6,
-            "level2": 4
-        },
-        "fontWeights": {
-            "level0": 400,
-            "level1": 400,
-            "level2": 400
-        }
-    }
-}
-```
-
-## Core Functions
-
-### `async initializeConfig(configSource)`
-
-Loads the configuration from a file or object. It automatically detects the environment (browser or Node.js) to use the appropriate file loading mechanism (`fetch` or `fs`). This should be called once when your application starts.
-
--   **`configSource`** (`string` | `object`, optional): A path to a JSON configuration file or a configuration object to use directly.
--   **Returns**: `Promise<void>`
-
-### `async getConfig()`
-
-Asynchronously gets the entire configuration object. If it hasn't been loaded yet, it will trigger the loading process with default settings.
-
--   **Returns**: `Promise<object>` - A promise that resolves to the configuration object.
-
-### `getConfigSync()`
-
-Synchronously gets the configuration object. 
-
-**Warning:** If called before `initializeConfig` has completed, this will return the default configuration, not the loaded one.
-
--   **Returns**: `object` - The configuration object.
-
-### `setConfig(config)`
-
-Sets the entire configuration directly, merging it with the default values.
-
--   **`config`** (`object`): The configuration object to set.
-
-### `getConfigValue(path)`
-
-Gets a specific configuration value using a dot-separated path (e.g., `'multiplication.symbol'`).
-
--   **Returns**: The value at the specified path.
-
-### `setConfigValue(path, value)`
-
-Sets a specific configuration value using a dot-separated path.
-
-## Utility Functions
-
--   **`getMultiplicationSymbol()`**: Returns the configured symbol for multiplication.
--   **`useImplicitMultiplication(combination)`**: Checks if implicit multiplication should be used, either globally or for a specific combination of operand types.
--   **`getDotRadius(level)`**: Gets the dot radius for a given step level in the `omdStepVisualizer`.
--   **`getFontWeight(level)`**: Gets the font weight for a given step level.
--   **`getDefaultConfig()`**: Returns a copy of the default configuration object.
--   **`isEnabled(category, setting)`**: Checks if a specific boolean setting is enabled.
--   **`updateConfig(category, setting, value)`**: Updates a top-level configuration setting.
--   **`resetConfig()`**: Throws an error. Direct file editing is required to reset the configuration.
--   **`async reloadConfig()`**: Forces a reload of the configuration from the original file path.
--   **`async getConfigAsync()`**: An alias for `getConfig()`.
-
-## Example
-
-```javascript
-import { initializeConfig, getConfigValue, setConfigValue } from '@teachinglab/omd';
-
-// Initialize at the start of your application
-(async () => {
-    await initializeConfig();
-
-    // Get a specific value
-    const multSymbol = getConfigValue('multiplication.symbol'); // -> '·'
-
-    // Change a value at runtime
-    setConfigValue('multiplication.symbol', '*');
-    const newSymbol = getConfigValue('multiplication.symbol'); // -> '*'
-})();
+# omdConfigManager
+
+A module for managing the configuration of the OMD library. It handles loading settings from a JSON file, providing default values, and allowing runtime modifications.
+
+## Overview
+
+The configuration is managed as a single JSON object. The system can be initialized with a path to a `omdConfig.json` file, or it will fall back to a default configuration. The manager supports both asynchronous and synchronous access to configuration values.
+
+### Default Configuration
+
+If no `omdConfig.json` is found, the following default structure is used:
+
+```json
+{
+    "multiplication": {
+        "symbol": "·",
+        "forceImplicit": false,
+        "implicitCombinations": {
+            "constantVariable": true,
+            "variableConstant": false,
+            "parenthesisAfterVariable": true,
+            "parenthesisAfterConstant": true,
+            "variableParenthesis": true,
+            "parenthesisParenthesis": true,
+            "parenthesisVariable": true,
+            "parenthesisConstant": true,
+            "variableVariable": true
+        }
+    },
+    "stepVisualizer": {
+        "dotSizes": {
+            "level0": 8,
+            "level1": 6,
+            "level2": 4
+        },
+        "fontWeights": {
+            "level0": 400,
+            "level1": 400,
+            "level2": 400
+        }
+    }
+}
+```
+
+## Core Functions
+
+### `async initializeConfig(configSource)`
+
+Loads the configuration from a file or object. It automatically detects the environment (browser or Node.js) to use the appropriate file loading mechanism (`fetch` or `fs`). This should be called once when your application starts.
+
+-   **`configSource`** (`string` | `object`, optional): A path to a JSON configuration file or a configuration object to use directly.
+-   **Returns**: `Promise<void>`
+
+### `async getConfig()`
+
+Asynchronously gets the entire configuration object. If it hasn't been loaded yet, it will trigger the loading process with default settings.
+
+-   **Returns**: `Promise<object>` - A promise that resolves to the configuration object.
+
+### `getConfigSync()`
+
+Synchronously gets the configuration object. 
+
+**Warning:** If called before `initializeConfig` has completed, this will return the default configuration, not the loaded one.
+
+-   **Returns**: `object` - The configuration object.
+
+### `setConfig(config)`
+
+Sets the entire configuration directly, merging it with the default values.
+
+-   **`config`** (`object`): The configuration object to set.
+
+### `getConfigValue(path)`
+
+Gets a specific configuration value using a dot-separated path (e.g., `'multiplication.symbol'`).
+
+-   **Returns**: The value at the specified path.
+
+### `setConfigValue(path, value)`
+
+Sets a specific configuration value using a dot-separated path.
+
+## Utility Functions
+
+-   **`getMultiplicationSymbol()`**: Returns the configured symbol for multiplication.
+-   **`useImplicitMultiplication(combination)`**: Checks if implicit multiplication should be used, either globally or for a specific combination of operand types.
+-   **`getDotRadius(level)`**: Gets the dot radius for a given step level in the `omdStepVisualizer`.
+-   **`getFontWeight(level)`**: Gets the font weight for a given step level.
+-   **`getDefaultConfig()`**: Returns a copy of the default configuration object.
+-   **`isEnabled(category, setting)`**: Checks if a specific boolean setting is enabled.
+-   **`updateConfig(category, setting, value)`**: Updates a top-level configuration setting.
+-   **`resetConfig()`**: Throws an error. Direct file editing is required to reset the configuration.
+-   **`async reloadConfig()`**: Forces a reload of the configuration from the original file path.
+-   **`async getConfigAsync()`**: An alias for `getConfig()`.
+
+## Example
+
+```javascript
+import { initializeConfig, getConfigValue, setConfigValue } from '@teachinglab/omd';
+
+// Initialize at the start of your application
+(async () => {
+    await initializeConfig();
+
+    // Get a specific value
+    const multSymbol = getConfigValue('multiplication.symbol'); // -> '·'
+
+    // Change a value at runtime
+    setConfigValue('multiplication.symbol', '*');
+    const newSymbol = getConfigValue('multiplication.symbol'); // -> '*'
+})();
 ```