braid-ui 1.0.0

package/README.md

@@ -0,0 +1,134 @@
+# Braid UI Kit
+
+A comprehensive React UI component library built with TypeScript, Tailwind CSS, and Radix UI.
+
+## Installation
+
+```bash
+npm install braid-ui-kit
+```
+
+## Usage
+
+### Import Components
+
+```tsx
+import { Button, Card, Dialog } from 'braid-ui-kit'
+
+function App() {
+  return (
+    <div>
+      <Button>Click me</Button>
+      <Card>
+        <h2>Card Title</h2>
+        <p>Card content</p>
+      </Card>
+    </div>
+  )
+}
+```
+
+### Import Hooks
+
+```tsx
+import { useToast, useEditState } from 'braid-ui-kit'
+
+function MyComponent() {
+  const { toast } = useToast()
+  const editState = useEditState()
+  
+  return (
+    <button onClick={() => toast({ title: "Hello!" })}>
+      Show Toast
+    </button>
+  )
+}
+```
+
+### Import Pages
+
+```tsx
+import { Dashboard, Alerts, Business } from 'braid-ui-kit'
+
+function App() {
+  return (
+    <Router>
+      <Routes>
+        <Route path="/" element={<Dashboard />} />
+        <Route path="/alerts" element={<Alerts />} />
+        <Route path="/business" element={<Business />} />
+      </Routes>
+    </Router>
+  )
+}
+```
+
+### Import Specific Categories
+
+You can also import from specific categories:
+
+```tsx
+// Import only components
+import { Button, Card } from 'braid-ui-kit/components'
+
+// Import only hooks
+import { useToast } from 'braid-ui-kit/hooks'
+
+// Import only pages
+import { Dashboard } from 'braid-ui-kit/pages'
+```
+
+## Development
+
+### Build the Library
+
+```bash
+npm run build:lib
+```
+
+### Watch Mode
+
+```bash
+npm run build:lib:watch
+```
+
+## Components
+
+The library includes:
+
+- **UI Components**: Basic building blocks like Button, Card, Dialog, etc.
+- **Form Components**: Form fields, inputs, and validation components
+- **Layout Components**: Page layouts, containers, and grid systems
+- **Business Components**: Specialized components for business applications
+- **Alert Components**: Alert and notification components
+
+## Hooks
+
+- `useToast`: Toast notification management
+- `useEditState`: Edit state management
+- `useFormWithEditState`: Form state with edit capabilities
+- `useMobile`: Mobile detection hook
+
+## Pages
+
+Pre-built page components for common business applications:
+
+- Dashboard
+- Alerts management
+- Business management
+- Transaction handling
+- Counterparty management
+
+## Dependencies
+
+This library requires React 18+ and includes peer dependencies for:
+
+- React
+- React DOM
+- Various Radix UI components
+- Tailwind CSS
+- Lucide React icons
+
+## License
+
+MIT