@illuminateeducation/dna-atd-frontend 1.0.1 → 1.0.2-DNAATD-3045-v3-POC.0

package/README.md

@@ -1,17 +1,13 @@
 # DNA ATD Frontend
 
-![Build and Publish](https://github.com/YOUR_USERNAME/dna-atd-frontend/workflows/Build%20and%20Publish%20to%20Private%20Repository/badge.svg)
-![CI](https://github.com/YOUR_USERNAME/dna-atd-frontend/workflows/Continuous%20Integration/badge.svg)
-![Release](https://github.com/YOUR_USERNAME/dna-atd-frontend/workflows/Release%20to%20Private%20Repository/badge.svg)
-
-Vue 3 application with feature-based architecture and backend integration.
+Vue 3 library with feature-based architecture and host-app integration helpers.
 
 ---
 
 ## Quick Start
 
 ```bash
-npm install
+npm ci
 npm run dev
 npm run build
 ```
@@ -38,32 +34,36 @@ src/
 
 ## Backend Integration
 
-**Pass data via HTML attributes:**
+This library reads backend bootstrap data from a host-provided global object (default: `window.APP_DATA`) and exposes it via Vue Provide/Inject.
+
+**Provide bootstrap data from PHP:**
 
 ```html
-<div id="app" 
-     data-config='{"api_url":"https://api.example.com"}'
-     data-user='{"id":1,"name":"John"}'>
-</div>
-<script type="module" src="/dist/assets/index.js"></script>
+<div id="app"></div>
+<script>
+  window.APP_DATA = {
+    config: { api_url: 'https://api.example.com' },
+    user: { id: 1, name: 'John' },
+  }
+</script>
 ```
 
-**Use in Vue:**
+**Consume in Vue (Composition API):**
 
 ```javascript
-import integration from '@/services/integration'
+import { useBackendContext } from '@illuminateeducation/dna-atd-frontend'
 
-const config = integration.getConfig()
-const user = integration.getUser()
+const { config, user } = useBackendContext()
 ```
 
 ---
 
 ## Build Configuration
 
-- Single JS/CSS output
-- Relative paths
-- Manifest generation
+This package is published as an **ESM-only** npm library.
+
+- Build output: `dist/index.es.js` + `dist/index.d.ts`
+- Library build: `npm run build`
 
 ---
 
@@ -74,4 +74,4 @@ const user = integration.getUser()
 
 ---
 
-**Built with Vue 3 + Vite + Pinia**
+**Built with Vue 3 + Vite + Pinia + Vuetify**