@mtngtools/frame-vue 0.0.8-experimental.0 → 0.0.10-experimental.0

package/README.md

@@ -3,12 +3,24 @@
 > [!WARNING]
 > This package is currently **experimental** and in early development. APIs are subject to frequent breaking changes.
 
-Vue.js component and composable library for mtngTOOLS. Built for use in Nuxt apps via a Nuxt module (to be added).
+Vue.js component and composable library for mtngTOOLS. Built for use in Nuxt apps via a Nuxt module.
 
-## Contents
+## Components
 
-- **Components** — Vue 3 SFCs (Composition API). Sample: `SampleGreeting`.
-- **Composables** — Shared logic. Sample: `useCounter`.
+| Component | Description |
+| --- | --- |
+| [`LiveFrame`](./src/components/live/LiveFrame) | Full-screen wrapper for live video players with responsive layout support. |
+| [`LoggedInOut`](./src/components/LoggedInOut) | Component that toggles content visibility based on authentication status. |
+| [`SidePanelFrame`](./src/components/live/SidePanelFrame) | Wrapper for controlling and displaying side panel content. |
+| [`SidePanelHeader`](./src/components/live/SidePanelHeader) | Standardized header component for the side panel. |
+| [`SidePanelButtonGroup`](./src/components/live/SidePanelButtonGroup) | Control group for managing panel selection buttons. |
+| [`SidePanelControlButton`](./src/components/live/SidePanelControlButton) | Interactive button for switching side panel states. |
+
+## Composables
+
+| Composable | Description |
+| --- | --- |
+| [`useSimpleLoggedIn`](./src/composables/useSimpleLoggedIn) | Shared reactive state for basic mobile/web "logged in" status. |
 
 ## Usage
 
@@ -18,11 +30,20 @@ Install in an app that already uses Vue 3 (e.g. a Nuxt app):
 pnpm add @mtngtools/frame-vue vue
 ```
 
+### Regular Imports
+
 ```ts
-import { SampleGreeting, useCounter } from '@mtngtools/frame-vue';
+import { LiveFrame, LoggedInOut } from '@mtngtools/frame-vue';
 ```
 
-In a Nuxt app, a Nuxt module can register these for auto-import (module to be created separately).
+### Direct Subpath Imports
+
+For specific needs or smaller bundle sizes, you can import directly from subpaths:
+
+```ts
+import { LoggedInOut } from '@mtngtools/frame-vue/components';
+import { useSimpleLoggedIn } from '@mtngtools/frame-vue/composables';
+```
 
 ## Requirements