@trapar-waves/react-tailwind 1.0.2 → 1.0.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Trapar waves
+
+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

@@ -1,29 +1,102 @@
-# Rsbuild Project
+# @trapar-waves/react-tailwind
 
-## Setup
+![npm version](https://img.shields.io/npm/v/@trapar-waves/react-tailwind)
+![npm dm](https://img.shields.io/npm/dm/@trapar-waves/react-tailwind)
+![License](https://img.shields.io/badge/license-ISC-green)
+![GitHub last commit](https://img.shields.io/github/last-commit/Trapar-waves/react-tailwind)
 
-Install the dependencies:
+> A project combining React and Tailwind CSS for modern UI development.
 
-```bash
-pnpm install
-```
+## ✨ Features
 
-## Get Started
+* **Modern UI Framework:** Built using React for a component-driven interface.
+* **Utility-First Styling:** Employs Tailwind CSS for flexible and rapid styling.
+* **Type Safety:** Leverages TypeScript to improve code quality and reduce runtime errors.
+* **Fast Development Workflow:** Utilizes Rsbuild for optimized builds and quick server starts.
+* **Icon Integration:** Likely includes support for Iconify, enabling scalable and customizable icons.
+* **Focus on Code Quality:** Includes ESLint with Antfu’s configuration, indicating attention to clean and maintainable code.
+* **PostCSS Integration:** Uses Tailwind's PostCSS plugin for advanced CSS handling.
 
-Start the dev server:
+## 🚀 Getting Started
 
-```bash
-pnpm dev
-```
+Follow these instructions to get the project running locally.
 
-Build the app for production:
+### Prerequisites
 
-```bash
-pnpm build
-```
+* Ensure you have the following installed:
+    * Node.js (>= 18.x recommended)
+    * Package manager (npm, yarn, or pnpm)
+    ```bash
+    node -v
+    npm -v # or yarn -v or pnpm -v
+    ```
+
+### Installation
 
-Preview the production build locally:
+1. Clone the repository:
+    ```bash
+    git clone https://github.com/Trapar-waves/react-tailwind.git
+    cd react-tailwind
+    ```
+2. Install dependencies:
+    ```bash
+    # Use your preferred package manager
+    npm install
+    # or
+    yarn install
+    # or
+    pnpm install
+    ```
 
+## 🛠️ Usage
+
+Explain how to run and use the project after installation.
+
+### Available Scripts
+
+Common scripts available via `npm run <script>`, `yarn <script>`, or `pnpm <script>`:
+
+* `dev`: Starts the development server and opens the app in the browser.
+* `build`: Creates a production-ready build.
+* `preview`: Launches a local server to preview the production build.
+
+Example:
 ```bash
-pnpm preview
+# Start development server
+npm run dev 
+
+# Create production build
+npm run build 
 ```
+
+## 💻 Tech Stack
+
+Key technologies used in this project include:
+
+* **Framework/Library:** React
+* **UI Toolkit/Styling:** Tailwind CSS
+* **Build Tool:** Rsbuild
+* **Language:** TypeScript
+* **Code Quality:** ESLint with Antfu configuration
+* **Icons:** Iconify integration
+
+See the [package.json](package.json) for a full list of dependencies.
+
+## 🤝 Contributing
+
+Contributions are welcome!
+
+## 📄 License
+
+Distributed under the **ISC** License. See `LICENSE` file for more information.
+
+## 👤 Author
+
+* **Rikka** ([admin@rikka.cc](mailto:admin@rikka.cc))
+* GitHub: [@Muromi-Rikka](https://github.com/Muromi-Rikka)
+
+## 🔗 Links
+
+* **Repository:** [https://github.com/Trapar-waves/react-tailwind](https://github.com/Trapar-waves/react-tailwind)
+* **Homepage:** [https://github.com/Trapar-waves/react-tailwind](https://github.com/Trapar-waves/react-tailwind)
+* **Issues:** [https://github.com/Trapar-waves/react-tailwind/issues](https://github.com/Trapar-waves/react-tailwind/issues)

package/package.json

@@ -1,7 +1,26 @@
 {
   "name": "@trapar-waves/react-tailwind",
   "type": "module",
-  "version": "1.0.2",
+  "version": "1.0.4",
+  "author": {
+    "email": "admin@rikka.cc",
+    "name": "Rikka",
+    "url": "https://github.com/Muromi-Rikka"
+  },
+  "homepage": "https://github.com/Trapar-waves/react-tailwind",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Trapar-waves/react-tailwind.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Trapar-waves/react-tailwind/issues"
+  },
+  "keywords": [
+    "react",
+    "rsbuild",
+    "tailwind",
+    "iconify"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -15,16 +34,16 @@
     "react-dom": "^19.1.0"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^4.11.0",
-    "@iconify/json": "^2.2.323",
+    "@antfu/eslint-config": "^4.12.0",
+    "@iconify/json": "^2.2.329",
     "@iconify/tailwind4": "^1.0.6",
-    "@rsbuild/core": "^1.3.4",
-    "@rsbuild/plugin-react": "^1.1.1",
-    "@tailwindcss/postcss": "^4.1.3",
-    "@types/react": "^19.1.0",
-    "@types/react-dom": "^19.1.1",
-    "eslint": "^9.24.0",
-    "tailwindcss": "^4.1.3",
+    "@rsbuild/core": "^1.3.9",
+    "@rsbuild/plugin-react": "^1.2.0",
+    "@tailwindcss/postcss": "^4.1.4",
+    "@types/react": "^19.1.2",
+    "@types/react-dom": "^19.1.2",
+    "eslint": "^9.25.0",
+    "tailwindcss": "^4.1.4",
     "typescript": "^5.8.3"
   }
 }

package/readme/README-CN.md

@@ -0,0 +1,124 @@
+# @trapar-waves/react-tailwind
+
+![npm 版本](https://img.shields.io/npm/v/@trapar-waves/react-tailwind)
+![月下载量](https://img.shields.io/npm/dm/@trapar-waves/react-tailwind)
+![许可证](https://img.shields.io/badge/license-ISC-green)
+![最近一次提交](https://img.shields.io/github/last-commit/Trapar-waves/react-tailwind)
+
+> 一个将 React 与 Tailwind CSS 相结合的现代化用户界面开发项目。
+
+## ✨ 核心特性
+
+* **现代化 UI 框架：** 基于 React，采用组件化驱动的设计理念。
+* **实用至上：** 使用 Tailwind CSS，提供灵活高效、快速上手的样式开发体验。
+* **类型安全保障：** 集成 TypeScript，提升代码质量并减少运行时错误。
+* **高效开发流程：** 通过 Rsbuild 进行优化构建，并快速启动开发服务器。
+* **图标支持：** 很可能集成了 Iconify，提供可扩展与高度可定制的图标解决方案。
+* **代码质量优先：** 配置了基于 Antfu 的 ESLint，注重代码整洁性与可维护性。
+* **PostCSS 集成：** 使用 Tailwind CSS 的 PostCSS 插件，实现更高级的 CSS 处理。
+
+## 🚀 快速入门指南
+
+按照以下步骤，快速在本地运行该项目。
+
+### 环境要求
+
+* 确保已安装以下工具：
+    * Node.js（推荐版本 >= 18.x）
+    * 包管理工具（npm、yarn 或 pnpm）
+    ```bash
+    node -v
+    npm -v # 或 yarn -v 或 pnpm -v
+    ```
+
+### 安装步骤
+
+1. 克隆代码库：
+    ```bash
+    git clone https://github.com/Trapar-waves/react-tailwind.git
+    cd react-tailwind
+    ```
+2. 安装依赖：
+    ```bash
+    # 使用你喜欢的包管理工具
+    npm install
+    # 或
+    yarn install
+    # 或
+    pnpm install
+    ```
+
+## 🛠️ 使用说明
+
+安装完成后，可以通过以下方式运行和使用项目。
+
+### 常用脚本
+
+通过 `npm run <脚本>`、`yarn <脚本>` 或 `pnpm <脚本>` 来运行以下命令：
+
+* `dev`：启动开发服务器，并在浏览器中打开应用。
+* `build`：生成适用于生产环境的构建版本。
+* `preview`：启动本地服务器，用于预览生产环境构建结果。
+
+示例：
+```bash
+# 启动开发服务器
+npm run dev 
+
+# 生成生产环境构建
+npm run build 
+```
+
+## 💻 技术栈概览
+
+该项目使用了以下关键技术：
+
+* **框架/库：** React
+* **样式解决方案：** Tailwind CSS
+* **构建工具：** Rsbuild
+* **编程语言：** TypeScript
+* **代码质量工具：** 基于 Antfu 配置的 ESLint
+* **图标支持：** 集成 Iconify
+
+完整的依赖列表可参考 [package.json](package.json) 文件。
+
+## 🤝 如何贡献
+
+欢迎任何形式的贡献！无论是代码优化、问题反馈，还是功能建议，都非常欢迎。
+
+## 📄 许可证
+
+本项目基于 **ISC** 许可证发布。更多详情请查看 `LICENSE` 文件。
+
+## 👤 作者信息
+
+* **Rikka** ([admin@rikka.cc](mailto:admin@rikka.cc))
+* GitHub: [@Muromi-Rikka](https://github.com/Muromi-Rikka)
+
+## 🔗 项目相关链接
+
+* **代码仓库：** [https://github.com/Trapar-waves/react-tailwind](https://github.com/Trapar-waves/react-tailwind)
+* **问题反馈：** [https://github.com/Trapar-waves/react-tailwind/issues](https://github.com/Trapar-waves/react-tailwind/issues)
+``` 
+
+### 改进说明
+
+1. **调整语言表达，使内容更贴近中文习惯**：
+   - 将“npm 每月下载量”改为“月下载量”。
+   - 将“GitHub 上次提交”改为“最近一次提交”。
+   - 优化句子结构，使描述更加自然流畅。
+
+2. **优化术语翻译**：
+   - 将“实用优先的样式设计”改为“实用至上”，更贴合 Tailwind CSS 的理念。
+   - 对技术术语进行了更准确的翻译，如“组件化驱动的设计理念”。
+
+3. **消除冗余表达**：
+   - 合并了“主页”和“代码仓库”重复的链接，仅保留必要的链接。
+   - 在“技术栈”部分简化了分类描述，避免重复。
+
+4. **提升清晰度**：
+   - 将“可能支持 Iconify”改为“很可能集成了 Iconify”，减少歧义。
+   - 对“完整的依赖列表”进行了更明确的说明。
+
+5. **增强可读性**：
+   - 优化句子结构，避免生硬的直译，使内容更符合中文读者的阅读习惯。

package/readme/README-JP.md

@@ -0,0 +1,100 @@
+# @trapar-waves/react-tailwind
+
+![npm バージョン](https://img.shields.io/npm/v/@trapar-waves/react-tailwind)
+![npm ダウンロード数（月間）](https://img.shields.io/npm/dm/@trapar-waves/react-tailwind)
+![ライセンス](https://img.shields.io/badge/license-ISC-green)
+![最終コミット日時](https://img.shields.io/github/last-commit/Trapar-waves/react-tailwind)
+
+> React と Tailwind CSS を統合した、現代的な UI 開発をサポートするプロジェクト。
+
+## ✨ 主な特徴
+
+* **モダンな UI フレームワーク:** コンポーネントベースの開発を効率化する React を採用。
+* **ユーティリティファーストのスタイリング:** 柔軟かつ迅速なデザイン調整を可能にする Tailwind CSS を統合。
+* **型安全性:** TypeScript を使用して、コード品質を高め、実行時のエラーを最小限に抑える設計。
+* **効率的な開発フロー:** 最適化されたビルドと高速なサーバー起動を実現する Rsbuild を採用。
+* **アイコンの統合:** Iconify をサポートし、拡張性とカスタマイズ性に優れたアイコンを提供。
+* **コード品質へのこだわり:** Antfu が提供する ESLint 設定を採用し、保守しやすいクリーンなコードを推奨。
+* **高度な CSS 処理:** Tailwind CSS の PostCSS プラグインを統合し、高度なスタイル調整を実現。
+
+## 🚀 始め方
+
+プロジェクトをローカル環境で実行する手順を紹介します。
+
+### 必要条件
+
+以下のツールがインストールされていることを確認してください:
+* Node.js (バージョン 18.x 以上を推奨)
+* パッケージマネージャ（npm、yarn、または pnpm）
+    ```bash
+    node -v
+    npm -v # または yarn -v または pnpm -v
+    ```
+
+### インストール
+
+1. リポジトリをクローン:
+    ```bash
+    git clone https://github.com/Trapar-waves/react-tailwind.git
+    cd react-tailwind
+    ```
+2. 依存関係をインストール:
+    ```bash
+    # お好みのパッケージマネージャを使用
+    npm install
+    # または
+    yarn install
+    # または
+    pnpm install
+    ```
+
+## 🛠️ 使い方
+
+インストールが完了したプロジェクトを実行・利用する方法を説明します。
+
+### 使用可能なスクリプト
+
+以下のスクリプトは `npm run`、`yarn`、または `pnpm` で実行可能です:
+* `dev`: 開発用サーバーを起動し、ブラウザでアプリケーションを確認できます。
+* `build`: 本番環境用の最適化されたビルドを生成します。
+* `preview`: 生成された本番ビルドをローカルでプレビューするためのサーバーを起動します。
+
+例:
+```bash
+# 開発用サーバーを起動
+npm run dev 
+
+# 本番用ビルドを生成
+npm run build 
+```
+
+## 💻 使用技術
+
+このプロジェクトで採用されている主要な技術スタック:
+* **フレームワーク/ライブラリ:** React
+* **UI スタイリング:** Tailwind CSS
+* **ビルドツール:** Rsbuild
+* **言語:** TypeScript
+* **コード品質:** Antfu の ESLint 設定を採用
+* **アイコン:** Iconify 統合
+
+依存関係の詳細は [package.json](package.json) をご参照ください。
+
+## 🤝 貢献
+
+皆さまの貢献を歓迎します！詳細はリポジトリをご覧ください。
+
+## 📄 ライセンス
+
+本プロジェクトは **ISC ライセンス** の下で配布されています。詳細は `LICENSE` ファイルをご覧ください。
+
+## 👤 作者
+
+* **Rikka** ([admin@rikka.cc](mailto:admin@rikka.cc))
+* GitHub: [@Muromi-Rikka](https://github.com/Muromi-Rikka)
+
+## 🔗 リンク
+
+* **リポジトリ:** [https://github.com/Trapar-waves/react-tailwind](https://github.com/Trapar-waves/react-tailwind)
+* **ホームページ:** [https://github.com/Trapar-waves/react-tailwind](https://github.com/Trapar-waves/react-tailwind)
+* **問題を報告:** [https://github.com/Trapar-waves/react-tailwind/issues](https://github.com/Trapar-waves/react-tailwind/issues)

package/readme/README-RU.md

@@ -0,0 +1,104 @@
+# @trapar-waves/react-tailwind
+
+![Версия npm](https://img.shields.io/npm/v/@trapar-waves/react-tailwind)
+![Загрузки npm в месяц](https://img.shields.io/npm/dm/@trapar-waves/react-tailwind)
+![Лицензия](https://img.shields.io/badge/license-ISC-green)
+![Последний коммит на GitHub](https://img.shields.io/github/last-commit/Trapar-waves/react-tailwind)
+
+> Современный проект, основанный на React и Tailwind CSS для разработки интуитивных пользовательских интерфейсов.
+
+## ✨ Особенности
+
+* **Компонентная структура:** Построен с использованием React, обеспечивающего гибкий и модульный подход к созданию UI.
+* **Утилитарный подход к стилизации:** Использует Tailwind CSS, что позволяет быстро и эффективно создавать адаптивные интерфейсы.
+* **Типобезопасность:** TypeScript гарантирует высокое качество кода и минимизирует риск ошибок на этапе выполнения.
+* **Оптимизированная разработка:** Rsbuild обеспечивает быстрые сборки и упрощает разработку благодаря продвинутым инструментам.
+* **Поддержка иконок:** Интеграция Iconify позволяет использовать масштабируемые и настраиваемые иконки.
+* **Качество кода:** Настроен ESLint с конфигурацией Antfu для поддержания чистоты и читаемости кода.
+* **Расширенная обработка CSS:** Плагин PostCSS от Tailwind CSS предоставляет дополнительные возможности для работы со стилями.
+
+## 🚀 Начало работы
+
+Чтобы запустить проект локально, выполните следующие шаги.
+
+### Предварительные требования
+
+Для работы с проектом убедитесь, что установлены следующие программы:
+* Node.js (рекомендуется версия 18.x или выше)
+* Менеджер пакетов (npm, yarn или pnpm)
+
+Проверьте версии:
+```bash
+node -v
+npm -v # или yarn -v или pnpm -v
+```
+
+### Установка
+
+1. Склонируйте репозиторий:
+    ```bash
+    git clone https://github.com/Trapar-waves/react-tailwind.git
+    cd react-tailwind
+    ```
+2. Установите зависимости:
+    ```bash
+    # Выберите предпочитаемый менеджер пакетов
+    npm install
+    # или
+    yarn install
+    # или
+    pnpm install
+    ```
+
+## 🛠️ Использование
+
+Раздел содержит инструкции по запуску и использованию проекта после установки.
+
+### Доступные команды
+
+Для запуска скриптов используйте `npm run <команда>`, `yarn <команда>` или `pnpm <команда>`:
+
+* `dev`: Запускает сервер разработки и открывает приложение в браузере.
+* `build`: Создает оптимизированную сборку для продакшена.
+* `preview`: Предоставляет возможность предварительно просмотреть продакшен-сборку.
+
+Пример:
+```bash
+# Запуск сервера разработки
+npm run dev 
+
+# Создание продакшен-сборки
+npm run build 
+```
+
+## 💻 Технологический стек
+
+Основные технологии, используемые в проекте:
+
+* **Фреймворк/Библиотека:** React
+* **Инструменты стилизации:** Tailwind CSS
+* **Сборщик:** Rsbuild
+* **Язык программирования:** TypeScript
+* **Контроль качества кода:** ESLint с конфигурацией Antfu
+* **Иконки:** Iconify
+
+Полный список зависимостей доступен в файле [package.json](package.json).
+
+## 🤝 Вклад
+
+Вклад в проект приветствуется! Если вы хотите предложить изменения или исправить ошибки, создайте pull request.
+
+## 📄 Лицензия
+
+Проект распространяется под лицензией **ISC**. Дополнительная информация доступна в файле [LICENSE](LICENSE).
+
+## 👤 Автор
+
+* **Рикка** ([admin@rikka.cc](mailto:admin@rikka.cc))
+* GitHub: [@Muromi-Rikka](https://github.com/Muromi-Rikka)
+
+## 🔗 Полезные ссылки
+
+* **Репозиторий:** [https://github.com/Trapar-waves/react-tailwind](https://github.com/Trapar-waves/react-tailwind)
+* **Домашняя страница:** [https://github.com/Trapar-waves/react-tailwind](https://github.com/Trapar-waves/react-tailwind)
+* **Сообщить о проблеме:** [https://github.com/Trapar-waves/react-tailwind/issues](https://github.com/Trapar-waves/react-tailwind/issues)