@underverse-ui/underverse 0.1.1 → 0.1.3

package/README.md

@@ -1,20 +1,28 @@
-Underverse UI
+# Underverse UI
 
-Thư viện UI component cho React/Next.js, tách từ dự án. Sử dụng Tailwind CSS, `clsx` và `tailwind-merge`. Một số component hỗ trợ `next-intl` (tùy chọn).
+**Author:** Tran Van Bach
 
-Yêu cầu
+A comprehensive UI component library for React/Next.js applications, extracted from the main project. Built with Tailwind CSS, `clsx`, and `tailwind-merge`. Some components support `next-intl` (optional).
+
+## Requirements
 - Node >= 18
-- Peer deps: `react`, `react-dom`, `next`, `next-intl`
+- Peer dependencies: `react`, `react-dom`, `next`, `next-intl`
+
+## Installation
+```bash
+# Install the package
+npm i @underverse-ui/underverse
 
-Cài đặt
-- npm: `npm i @underverse-ui/underverse`
-- Peer deps (nếu app chưa có): `npm i react react-dom next next-intl`
+# Install peer dependencies (if not already in your app)
+npm i react react-dom next next-intl
+```
 
-Thiết lập Tailwind (gợi ý)
-- Các component dùng biến màu kiểu `primary`, `secondary`, `destructive`, v.v. Đảm bảo theme/tokens trong Tailwind của bạn có các biến này.
+## Tailwind CSS Configuration
+Components use color variables like `primary`, `secondary`, `destructive`, etc. Make sure your Tailwind theme/tokens include these variables.
 
-Sử dụng nhanh
+## Quick Start
 
+```tsx
 import { Button, ToastProvider, useToast } from "@underverse-ui/underverse";
 
 function App() {
@@ -27,30 +35,42 @@ function App() {
     </ToastProvider>
   );
 }
+```
+
+## Exported Components
+
+### Core Components
+- **Buttons:** `Button`
+- **Display:** `Badge`, `Card`, `Avatar`, `Skeleton`, `Progress`
+- **Form Inputs:** `Input`, `Textarea`, `Checkbox`, `Switch`, `Label`
+
+### Feedback & Overlays
+- `Modal`, `ToastProvider`, `useToast`, `Tooltip`, `Popover`, `Sheet` (includes `Drawer`, `SlideOver`, `BottomSheet`, `SidebarSheet`), `Alert`, `GlobalLoading` (includes `PageLoading`, `InlineLoading`, `ButtonLoading`)
+
+### Form Controls & Pickers
+- `RadioGroup`, `Slider`, `DatePicker`, `Combobox`, `MultiCombobox`, `CategoryTreeSelect`
+
+### Navigation & Structure
+- `Breadcrumb`, `Tabs` (includes `SimpleTabs`, `PillTabs`, `VerticalTabs`), `DropdownMenu`, `Pagination`, `Section`, `ScrollArea`
+
+### Data Display
+- `Table`, `DataTable`
+
+### Media Components
+- `SmartImage`, `ImageUpload`, `ProductImageUpload`, `Carousel`
+
+### Utilities
+- `ClientOnly`, `Loading`, `NotificationModal`, `FloatingContacts`, `AccessDenied`
+- Utility functions: `cn`, `DateUtils`, style constants
+
+## Important Notes
+- Some components (like `DatePicker`) depend on `next-intl`. If your app doesn't use `next-intl`, either import only components without this dependency or install `next-intl` as a peer dependency.
+- `NotificationBell` is **not exported** to keep the package neutral (it depends on project-specific API/socket implementations).
+
+## License
+
+MIT
+
+## Author
 
-Các component đã export (tiêu biểu)
-- Buttons: `Button`
-- Thông báo/feedback: `ToastProvider`, `useToast`, `Modal`, `Tooltip`, `Popover`, `Sheet`, `Alert`, `GlobalLoading`
-- Form/nhập liệu: `Input`, `Textarea`, `Checkbox`, `RadioGroup`, `Slider`, `DatePicker`, `Combobox`, `MultiCombobox`, `CategoryTreeSelect`
-- Trình bày: `Badge`, `Card`, `Table`, `DataTable`, `Tab/Tabs`, `Section`, `ScrollArea`, `Skeleton`, `Progress`
-- Media: `SmartImage`, `ImageUpload`, `ProductImageUpload`, `Carousel`
-- Khác: `Avatar`, `ClientOnly`, `Loading`, `ThemeToggle`, `NotificationModal`, `FloatingContacts`, `Breadcrumb`, `DropdownMenu`, `Pagination`
-
-Lưu ý
-- Một số component (như `DatePicker`, `Form`) dùng `next-intl`. Nếu app không dùng `next-intl`, chỉ import các component không phụ thuộc hoặc cài `next-intl` như peer.
-- `NotificationBell` (phụ thuộc API/socket cụ thể dự án) không được export để giữ package trung tính.
-
-Phát triển & build (local)
-- Trong thư mục package: `cd packages/underverse`
-- Cài deps: `npm i`
-- Build: `npm run build` (xuất ESM + CJS + d.ts vào `dist/`)
-- Kiểm tra gói: `npm pack` (tạo file `.tgz` để test cài đặt cục bộ)
-
-Publish lên npm (tóm tắt)
-1) `cd packages/underverse`
-2) Đăng nhập: `npm login`
-3) Tăng version: `npm version patch` (hoặc `minor|major`)
-4) Publish: `npm publish --access public`
-   - Dùng beta tag: `npm publish --access public --tag beta`
-
-Chi tiết từng bước xem thêm trong PUBLISHING.md cùng thư mục.
+Tran Van Bach

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@underverse-ui/underverse",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "private": false,
   "description": "Underverse UI – reusable React/Next.js UI components",
   "type": "module",
@@ -19,9 +19,14 @@
   ],
   "sideEffects": false,
   "scripts": {
+    "dev": "tsup --config tsup.config.ts --watch",
     "build": "tsup --config tsup.config.ts",
     "clean": "rimraf dist",
-    "prepublishOnly": "npm run clean && npm run build"
+    "prepublishOnly": "npm run clean && npm run build",
+    "release": "node ./scripts/release.mjs",
+    "release:patch": "node ./scripts/release.mjs patch",
+    "release:minor": "node ./scripts/release.mjs minor",
+    "release:major": "node ./scripts/release.mjs major"
   },
   "peerDependencies": {
     "react": ">=18",