@getaster/elements 0.2.0 → 0.3.0

package/NOTICE

@@ -1,10 +1,5 @@
-Aster UI
+@getaster/elements
 Copyright 2026 Aster UI contributors
 
-Aster UI source and the separately supplied OData mock WebAssembly binary are
-licensed under the Apache License, Version 2.0. Third-party components retain
-their respective licenses. The binary's attribution inventory and license texts
-are supplied in packages/mock/wasm/; packages include those notices when shipped.
-
-Geist and IBM Plex Mono fonts retain their SIL Open Font License notices.
-ECharts is an optional separately loaded third-party runtime.
+Aster UI code in this package is licensed under the Apache License, Version 2.0.
+See LICENSE. Separately installed dependencies retain their respective licenses.

package/README.md

@@ -1,7 +1,72 @@
 # @getaster/elements
 
-Aster UI elements.
+Browser-native controls for metadata-driven enterprise applications: grids,
+forms, pickers, filters, dashboards and workspaces. Controls share records and
+edit state through `@getaster/data` and use CSS for layout and theming.
 
-Documentation: https://ui.getaster.now/docs/guide/library.html
+Aster is pre-1.0; production API stability is not yet promised. Experimental
+controls are published separately in `@getaster/elements-preview`.
 
-Licensed under Apache-2.0. See LICENSE and NOTICE.
+## Install
+
+```sh
+npm install @getaster/data @getaster/elements
+```
+
+Use a modern browser with custom elements and ES modules, plus a bundler that
+resolves npm modules and CSS imports. The package ships TypeScript declarations.
+Its main entry registers browser elements and requires a DOM; use
+`@getaster/data` for headless work. Package tooling requires Node 22 or later.
+
+## Connect a grid
+
+With an OData service exposing a `Projects` entity set and JSON CSDL metadata:
+
+```ts
+import { DataContext, fetchTransport } from '@getaster/data';
+import { Grid } from '@getaster/elements';
+import '@getaster/elements/styles/aster-ui.css';
+
+const ctx = await DataContext.connect(
+  fetchTransport('https://your-service.example/odata/')
+);
+const grid = new Grid();
+grid.ctx = ctx;
+grid.set = 'Projects';
+grid.label = 'Projects';
+grid.style.height = '24rem';
+document.body.append(grid);
+```
+
+Replace the endpoint and entity set with your own. Give a virtualized grid a
+bounded height, and supply your application's theme tokens as described in the
+[theming guide](https://ui.getaster.now/docs/guide/themes.html). When the view
+closes, remove the element; separately owned data models remain the host's
+responsibility.
+
+## Compose an application
+
+Use a shared data context to connect a grid, form and selection. JavaScript and
+YAML composition support reusable workspace definitions. Controls provide
+keyboard interaction and semantic markup; application labels, focus flow and
+accessibility still need testing in the completed application.
+
+The package depends on Aster's data core, Lit HTML and Preact signals. Keep one
+compatible copy of each shared runtime in your build. The optional ECharts
+adapter accepts an application-supplied runtime; ECharts, showcase data, fonts
+and the mock service are not bundled into this package. There are no install
+scripts.
+
+## Documentation and support
+
+- [Get started](https://ui.getaster.now/docs/guide/getting-started.html)
+- [Connected views](https://ui.getaster.now/docs/guide/connected-views.html)
+- [Workspace composition](https://ui.getaster.now/docs/guide/declarative-workspace.html)
+- [API reference](https://ui.getaster.now/docs/reference/)
+- [Interactive showcase](https://ui.getaster.now/showcase/)
+- [Report a bug](https://github.com/GetAster/aster-ui/issues)
+
+## License
+
+Apache-2.0. See the included `LICENSE` and package-specific `NOTICE`.
+Separately installed dependencies retain their own licenses.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getaster/elements",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "type": "module",
   "exports": {
     ".": {
@@ -11,7 +11,7 @@
     "./styles/*": "./styles/*"
   },
   "dependencies": {
-    "@getaster/data": "0.2.0",
+    "@getaster/data": "0.3.0",
     "@preact/signals-core": "1.14.4",
     "lit-html": "3.3.3"
   },
@@ -24,6 +24,18 @@
     "url": "git+https://github.com/GetAster/aster-ui.git",
     "directory": "packages/elements"
   },
+  "description": "Browser-native grids, forms and workspace controls backed by shared Aster data models.",
+  "homepage": "https://ui.getaster.now/docs/guide/getting-started.html",
+  "bugs": {
+    "url": "https://github.com/GetAster/aster-ui/issues"
+  },
+  "keywords": [
+    "web-components",
+    "odata",
+    "grid",
+    "forms",
+    "typescript"
+  ],
   "types": "./dist/index.d.ts",
   "publishConfig": {
     "access": "public"