@colletdev/core 0.1.3

package/README.md

@@ -0,0 +1,77 @@
+# @collet/core
+
+48 accessible web components built in Rust, compiled to WASM, distributed as Custom Elements. Component-level WCAG 2.2 AA constraints are enforced at compile time -- page-level integration (focus order, layout, slotted content) remains the consumer's responsibility. WASM loads on interaction only.
+
+## Install
+
+```bash
+npm install @collet/core
+```
+
+## Quick Start
+
+```js
+import { init } from '@collet/core';
+
+await init(); // registers all <cx-*> elements
+```
+
+```html
+<cx-button variant="filled" label="Save" intent="primary"></cx-button>
+<cx-text-input label="Email" kind="email" placeholder="you@example.com"></cx-text-input>
+```
+
+## Selective Loading
+
+```js
+await init({ components: ['button', 'text-input', 'select'] }); // tree-shakes the rest
+await init({ lazy: true });                                      // defer WASM until interaction
+```
+
+## Theming
+
+Collet uses CSS custom properties for all colors, spacing, typography, and motion. Override the defaults in your own stylesheet or generate a custom `tokens.css` with [@collet/tokens](https://github.com/Danrozen87/collet-tokens).
+
+```css
+:root {
+  --color-primary: oklch(0.55 0.22 265);
+  --color-surface: oklch(0.98 0 0);
+  --radius-md: 0.5rem;
+}
+```
+
+## Vite Plugin
+
+Handles WASM MIME types, asset copying, preload hints, and Declarative Shadow DOM pre-rendering.
+
+```js
+import { colletPlugin } from '@collet/core/vite-plugin';
+export default defineConfig({ plugins: [colletPlugin()] });
+```
+
+## SSR
+
+Server-side rendering helpers are available via the `/server` export:
+
+```js
+import { renderToString } from '@collet/core/server';
+```
+
+## Exports
+
+| Export | Description |
+|--------|-------------|
+| `@collet/core` | `init()`, element registrations, TypeScript types |
+| `@collet/core/runtime` | Base classes (`CxElement`, `CxFormElement`) |
+| `@collet/core/vite-plugin` | Vite integration |
+| `@collet/core/server` | SSR utilities |
+| `@collet/core/markdown` | `renderMarkdown()` / `renderMarkdownSync()` |
+| `@collet/core/elements/*` | Individual Custom Element definitions |
+
+## IDE Support
+
+A `custom-elements.json` manifest is included. VS Code, WebStorm, and Lit-based tooling will pick it up for autocomplete and documentation on `<cx-*>` tags.
+
+## License
+
+MIT -- [github.com/Danrozen87/collet](https://github.com/Danrozen87/collet)