@loykin/designkit 0.0.1-dev.4 → 0.0.1-dev.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Loykin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -13,21 +13,28 @@ npm install @loykin/designkit
 
 Requires React 19 and Tailwind CSS v4. UI components are based on [shadcn/ui](https://ui.shadcn.com) — if your app has shadcn set up, theming integrates automatically via shared CSS variables (`--primary`, `--background`, `--radius`, etc.).
 
-Import the styles in your global CSS:
+shadcn/ui is the component and semantic-token convention, not a runtime
+dependency. Consumers do not need to install the shadcn CLI, but they must use
+Tailwind CSS v4 and should define the shared semantic variables they want to
+customize.
+
+Import Tailwind and DesignKit from the same global CSS entry:
 
 ```css
 /* globals.css */
+@import "tailwindcss";
 @import "@loykin/designkit/styles";
 ```
 
-The styles file includes pre-built Tailwind utility classes — no `@source` configuration required. You can also import the stylesheet from your app entry, as shown below.
+`@loykin/designkit/styles` registers the package's compiled JavaScript as a
+Tailwind source. The consuming application's Tailwind v4 build generates the
+utilities for both the application and DesignKit in one cascade. DesignKit does
+not ship a second, pre-built copy of Tailwind utilities.
 
 ## Quick Start
 
 ```tsx
 import { DataBodyTemplate, PageTopBar, Button } from '@loykin/designkit'
-import '@loykin/designkit/styles'
-
 export function UsersPage() {
   return (
     <DataBodyTemplate
@@ -68,6 +75,7 @@ General-purpose page shell. Accepts `.Body`, `.Tab`, and `.Section` child slots
 | `topBar` | `ReactNode` | Top breadcrumb bar. Pass `<PageTopBar left="..." />` or omit. |
 | `title` | `ReactNode` | Page title |
 | `description` | `ReactNode` | Subtitle below the title |
+| `status` | `ReactNode` | Badge or tag rendered inline next to the title |
 | `actions` | `ReactNode` | Page-level actions (Add, Export, etc.) next to the title |
 | `toolbarLeft` / `toolbarRight` | `ReactNode` | Toolbar slots above the content area |
 | `theme` | `CSSProperties` | Inline CSS variable overrides |
@@ -334,6 +342,7 @@ export function SqlEditorPage() {
 |---|---|---|
 | `topBar` | `ReactNode` | Top bar above the workbench |
 | `title` / `description` | `ReactNode` | Header copy above the panes |
+| `status` | `ReactNode` | Badge or tag rendered inline next to the title |
 | `headerRight` / `actions` | `ReactNode` | Header action slots |
 | `leftPane` / `rightPane` | `ReactNode` | Optional side panes |
 | `mainPane` | `ReactNode` | Primary editor or preview area |