@viliha/vui-ui 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,82 @@
+# @viliha/vui-ui
+
+A clean, **token-driven React admin/CRM component library** built on Tailwind
+CSS v4, shadcn-style patterns, and Radix Icons. Ships as **TypeScript source**
+(Just-in-Time) — your app's bundler compiles only what you import.
+
+Part of [**Vui Starter**](https://github.com/myviliha/vui-starter) — a free,
+open-source admin design system. See the repo for the full docs, a live
+backoffice demo, and per-toolchain setup guides.
+
+## Install
+
+```bash
+npm install @viliha/vui-ui       # or: pnpm add / yarn add / bun add
+npm install -D tailwindcss @tailwindcss/postcss
+```
+
+`react` and `react-dom` are peer dependencies.
+
+## Setup
+
+**1. Import the theme** in your global stylesheet (design tokens, `@theme`
+mapping, base reset, and component scanning — all in one import):
+
+```css
+@import "tailwindcss";
+@import "@viliha/vui-ui/theme.css";
+```
+
+**2. Next.js only** — transpile the source package in `next.config.ts`:
+
+```ts
+const nextConfig = { transpilePackages: ["@viliha/vui-ui"] };
+export default nextConfig;
+```
+
+(Vite and most bundlers need no extra config.)
+
+## Usage
+
+Each component is its own entry point, so you only ship what you use:
+
+```tsx
+import { Button } from "@viliha/vui-ui/button";
+import { Badge } from "@viliha/vui-ui/badge";
+import { RecordView, type RecordField } from "@viliha/vui-ui/record-view";
+
+export function Example() {
+  return (
+    <div className="p-4">
+      <Badge variant="success">Active</Badge>
+      <Button variant="primary">Save</Button>
+    </div>
+  );
+}
+```
+
+## Components
+
+`avatar` · `badge` · `button` · `card` · `chart` (themed Recharts wrapper) ·
+`checkbox` · `dialog` · `confirm-dialog` · `dropdown-menu` · `input` · `menu` ·
+`select` · `table` · `record-view` (the full datatable) · plus the `utils`
+(`cn`) helper and the `theme.css` design tokens.
+
+## Theming
+
+Every design decision lives in `@viliha/vui-ui/theme.css` as CSS variables
+(colors, radius, typography, dark mode). Override any token **after** the import
+to rebrand the whole system:
+
+```css
+@import "@viliha/vui-ui/theme.css";
+
+:root {
+  --primary: oklch(0.55 0.2 260);
+  --radius: 0.5rem;
+}
+```
+
+## License
+
+MIT © Suman Bonakurthi

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@viliha/vui-ui",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Vui UI — a clean, token-driven React admin/CRM component library built on Tailwind CSS v4, shadcn-style patterns, and Radix Icons. Ships as TypeScript source (Just-in-Time), compiled by the consuming app.",
   "license": "MIT",
   "author": "Suman Bonakurthi",