@platned/ui 0.1.2

package/README.md

@@ -0,0 +1,68 @@
+# @platned/ui
+
+Platned Design System — React component library used across Platned products.
+
+## Install
+
+```bash
+npm install @platned/ui
+```
+
+## Usage
+
+```tsx
+// Import styles once at your app root
+import '@platned/ui/styles'
+
+// Use components
+import { Button, Input, Modal, DataTable } from '@platned/ui'
+import { AppSidebar } from '@platned/ui/sidebar'
+```
+
+## Tailwind users
+
+If your project uses Tailwind CSS, extend your config with the Platned preset instead of importing the pre-built CSS:
+
+```js
+// tailwind.config.js
+module.exports = {
+  presets: [require('@platned/ui/tailwind-preset')],
+}
+```
+
+## AppSidebar
+
+The sidebar ships as a separate entry point to avoid forcing `react-router-dom` on consumers who don't need it.
+
+```tsx
+import { AppSidebar } from '@platned/ui/sidebar'
+
+<AppSidebar
+  collapsed={false}
+  onToggle={() => {}}
+  userName="Jane Smith"
+  userRole="Admin"
+  onLogout={() => signOut()}
+/>
+```
+
+## Development
+
+```bash
+npm run build        # build package (tsup + CSS)
+npm run build:watch  # watch mode
+npm run typecheck    # TypeScript check
+npm run docs         # start docs dev server
+npm run docs:build   # build docs for deployment
+```
+
+## Docs
+
+Run `npm run docs` and open `http://localhost:5173` to browse the component library with live examples.
+
+## Publishing
+
+```bash
+npm run build && npm run typecheck
+npm publish --access public
+```