fix: make ui package standalone

README.md

@@ -0,0 +1,36 @@
+# Dimension Lab UI
+
+Reusable React component package for Dimension Lab dashboards.
+
+## Use As A Submodule
+
+```sh
+git submodule add -b main ssh://git@git.dimensionlab.net/vince/dimensionlab-ui.git packages/ui
+git submodule update --init --recursive
+bun install
+```
+
+The package is workspace-friendly as `@dimensionlab/ui`. Keep the consuming
+repo's workspace configuration pointed at the checked-out package path.
+
+## Use As A Git Package
+
+The package exports built files from `dist/`. Git-package consumers can depend
+on the repository directly; the `prepare` script builds `dist/` during install.
+
+```json
+{
+  "dependencies": {
+    "@dimensionlab/ui": "git+ssh://git@git.dimensionlab.net/vince/dimensionlab-ui.git#main"
+  }
+}
+```
+
+## Development
+
+```sh
+bun install
+bun run check
+bun run test
+bun run build
+```