varmory 1.0.3 → 1.0.5

package/README.md

@@ -1,6 +1,11 @@
 # varmory
 
-Vue 3 + Quasar component library with a multi-theme system.
+Component showcase for Vue 3 + Quasar apps, with a Model Context Protocol server so AI agents can read your components and docs.
+
+Drop in an interactive browser for the Quasar components you use and any custom ones you build, and expose the same metadata to tools like Claude via MCP — no extra glue needed.
+
+- [Component Showcase](https://varmory-dec8b20a1b83.herokuapp.com/)
+- [MCP Server](https://varmory-dec8b20a1b83.herokuapp.com/#docs/MCP)
 
 ## Installation
 
@@ -11,40 +16,48 @@ npm install varmory
 Peer dependencies:
 
 ```bash
-npm install vue@^3 quasar@^2 pinia@^3 @quasar/extras@^1
+npm install vue@^3 quasar@^2 @quasar/extras@^1
 ```
 
 ## Setup
 
+Quasar components are registered by `@quasar/vite-plugin` in your Vite config:
+
 ```js
-import { createApp } from 'vue';
-import { createPinia } from 'pinia';
-import { install as Varmory } from 'varmory';
-
-const app = createApp(App);
-app.use(createPinia());
-app.use(Varmory, {
-    theme: 'space', // optional. Default is 'default'
-});
+// vite.config.js
+import vue from '@vitejs/plugin-vue';
+import { quasar, transformAssetUrls } from '@quasar/vite-plugin';
+
+export default {
+	plugins: [
+		vue({ template: { transformAssetUrls } }),
+		quasar({ autoImportComponentCase: 'pascal' }),
+	],
+};
 ```
 
+In your app's entry file, attach Quasar to the Vue app **before** Varmory, then install Varmory as a Vue plugin. Varmory registers `JComponentShowcase` + `JComponentShowcaseWithContent` globally and throws if Quasar isn't already installed.
 
-## Usage
-
-See [docs/USAGE.md](docs/USAGE.md) — setting up a fresh app using varmory for UI, Vite config, and Quasar plugin setup.
-
-## Building Components
-
-See [docs/CustomComponents.md](docs/CustomComponents.md) — API style, CSS variables, layout patterns, component composition, and styling conventions.
-
-## Theming, Dark/Light mode
-
-See [docs/THEMING.md](docs/THEMING.md) — built-in themes, custom themes, writing your own, theme store API, and UI components.
-
-## JComponentShowcase
+```js
+// main.js
+import { createApp } from 'vue';
+import { Quasar, Notify, Dialog, LocalStorage, SessionStorage } from 'quasar';
+import { Varmory } from 'varmory';
+import 'quasar/dist/quasar.css';
+import '@quasar/extras/material-icons/material-icons.css';
+import App from './App.vue';
+
+createApp(App)
+	.use(Quasar, { plugins: { Notify, Dialog, LocalStorage, SessionStorage } })
+	.use(Varmory)
+	.mount('#app');
+```
 
-See [docs/SHOWCASE.md](docs/SHOWCASE.md) — interactive component browser, adding categories, custom docs, writing showcase entries, and navigation.
+See [USAGE.md](https://varmory-dec8b20a1b83.herokuapp.com/#docs/USAGE) for the rest of the setup details.
 
-## MCP Server
+## Docs
 
-See [docs/MCP.md](docs/MCP.md) — expose showcase data to AI agents via the Model Context Protocol.
+- [Usage](https://varmory-dec8b20a1b83.herokuapp.com/#docs/USAGE) — setting up a fresh app, Vite config, Quasar plugin wiring
+- [Building Components](https://varmory-dec8b20a1b83.herokuapp.com/#docs/CustomComponents) — API style, layout patterns, component composition
+- [Showcase](https://varmory-dec8b20a1b83.herokuapp.com/#docs/SHOWCASE) — interactive browser, adding categories, custom docs, navigation
+- [MCP Server](https://varmory-dec8b20a1b83.herokuapp.com/#docs/MCP) — expose showcase + docs + component APIs to AI agents via MCP