beca-ui 2.1.0 → 2.1.1-beta.10

package/README.md

@@ -1,31 +1,100 @@
-<!-- # React + TypeScript + Vite
+# Beca UI - Thư viện React Component Library
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+Beca UI là bộ thư viện React Component chính thức được phát triển bởi đội ngũ Becawork. Thư viện này kế thừa sức mạnh của Ant Design (antd) và được tinh chỉnh, mở rộng các component UI cao cấp để phù hợp với hệ sinh thái sản phẩm Becawork.
 
-Currently, two official plugins are available:
+## 🚀 Tính năng nổi bật
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+- **Tích hợp sẵn TypeScript**: Hỗ trợ kiểu dữ liệu (type) đầy đủ và an toàn.
+- **Tối ưu hóa UI/UX**: Thiết kế hiện đại, hỗ trợ tùy biến giao diện linh hoạt (Light/Dark mode, Custom Themes).
+- **Component đa dạng**: Hỗ trợ đầy đủ các component từ cơ bản (Buttons, Inputs, Forms...) đến nâng cao (TextEditor, Layouts, Media Players...).
+- **Storybook tích hợp**: Giúp dễ dàng xem trước và kiểm thử các component trong quá trình phát triển.
 
-## Expanding the ESLint configuration
+---
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+## 📦 Cài đặt
 
-- Configure the top-level `parserOptions` property like this:
+Sử dụng `npm` hoặc `yarn` để cài đặt thư viện vào dự án của bạn:
 
-```js
-   parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json'],
-    tsconfigRootDir: __dirname,
-   },
+```bash
+yarn add beca-ui
+# hoặc
+npm install beca-ui
 ```
 
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
+---
 
- -->
+## 💻 Cách sử dụng
 
-https://dev.to/receter/how-to-create-a-react-component-library-using-vites-library-mode-4lma
+Import trực tiếp file CSS và các Component cần thiết vào dự án của bạn:
+
+```tsx
+import React from "react";
+import { Button, Tooltip } from "beca-ui";
+import "beca-ui/dist/main.css";
+
+const App = () => {
+  return (
+    <Tooltip title="Đây là Tooltip từ beca-ui">
+      <Button type="primary">Beca UI Button</Button>
+    </Tooltip>
+  );
+};
+
+export default App;
+```
+
+---
+
+## 🛠️ Phát triển & Đóng góp (Development)
+
+Nếu bạn muốn chỉnh sửa hoặc thêm component mới vào thư viện:
+
+### 1. Cài đặt các gói phụ thuộc (Dependencies)
+
+```bash
+yarn install
+```
+
+### 2. Chạy Storybook để phát triển UI
+
+```bash
+yarn dev
+# hoặc
+yarn storybook
+```
+
+Storybook sẽ được khởi chạy trên trình duyệt của bạn.
+
+### 3. Kiểm tra mã nguồn (Linter)
+
+```bash
+yarn lint
+```
+
+### 4. Build thư viện phục vụ cho việc release
+
+```bash
+yarn build
+```
+
+Lệnh này sẽ biên dịch TypeScript và đóng gói các component bằng Vite sang thư mục `dist/`.
+
+---
+
+## 📋 Nhật ký thay đổi (Changelog)
+
+Chi tiết các thay đổi qua các phiên bản được ghi nhận tại file [CHANGELOG.md](file:///Users/hautp/Work/beca-ui/CHANGELOG.md).
+
+### Phiên bản gần đây:
+- **`2.1.1-beta.9` (2026-07-15)**:
+  - Cập nhật tài liệu hướng dẫn và lược bỏ thông tin cấu hình nhạy cảm.
+  - Bổ sung Tooltip hiển thị tên tài khoản (username) trên thanh Header.
+  - Tự động hóa quy trình nâng phiên bản và cập nhật changelog.
+- **`2.1.1-beta.8` (2026-07-15)**:
+  - Nâng cấp toàn diện component `TextEditor` (hỗ trợ Fullscreen và Compact mode).
+
+---
+
+## ⚖️ Giấy phép (License)
+
+Dự án được phân phối dưới giấy phép **MIT**.