@soroka282/migrant.ui-kit 0.0.19 → 0.0.21

package/README.md

@@ -1,5 +1,120 @@
-# Vue 3 + TypeScript + Vite
+# 📖 Migrant UI Kit
 
-This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+Библиотека переиспользуемых компонентов для проектов Migrant. Построена на [Vue 3](https://vuejs.org/) с поддержкой TypeScript и scoped-стилей.
+
+## 📦 Установка
+
+```bash
+  npm install @soroka282/migrant.ui-kit
+# или
+  yarn add @soroka282/migrant.ui-kit
+```
+
+## 💻 Разработка
+
+```bash
+  npm run dev
+```
+
+## 🧪 Коммиты
+
+Формат коммитов:
+
+```
+<номер задачи>/<тип>(<scope>): <описание>
+```
+
+Если задача в трекере отсутствует:
+
+```
+<тип>(<scope>): <описание>
+```
+
+### Типы коммитов:
+
+- `feat` — добавление нового функционала
+- `fix` — исправление ошибок
+- `docs` — изменение документации
+- `build` — сборка и настройка инфраструктуры (vite, tsconfig и т.п.)
+
+### Примеры:
+
+```
+EVOLVE-1/feat(useIframeHandler): добавлен новый composable метод
+EVOLVE-2/fix(UIInput): обработка событий при потере фокуса
+EVOLVE-3/build(vite.config): релиз библиотеки
+
+feat(useIframeHandler): добавлен новый composable метод
+build(vite.config): релиз библиотеки
+```
+
+## 🛠️ Сборка библиотеки
+
+```bash
+    npm run build         # билд библиотеки
+    npm run ts            # генерация .d.ts
+    npm run publish:npm   # билд + публикация
+```
+
+## 📖 Storybook
+
+```bash
+    npm run storybook          # запуск
+    npm run build:storybook    # сборка
+```
+
+## 🥉 Используемые зависимости
+
+- [Vue 3](https://vuejs.org/) — основной фреймворк
+- [Pinia](https://pinia.vuejs.org/) — управление состоянием
+- [Maska](https://beholdr.github.io/maska/) — маски ввода
+- [Swiper](https://swiperjs.com/) — свайпер/карусель
+- [Vue-toastification](https://vue-toastification.maronato.dev/) — уведомления (тосты)
+
+## 🛠️ Использование компонентов
+
+```
+<script setup lang="ts">
+    import {
+      UIButton,
+      UIColor,
+      UIColorName,
+      UISize,
+    } from '@soroka282/migrant.ui-kit';
+</script>
+
+<template>
+  <UIButton
+    is-box-shadow
+    :size="UISize.S"
+    :color="UIColor[UIColorName.White]"
+    :bg-color="UIColor[UIColorName.PurpleMain]"
+  >
+    Кнопка
+  </UIButton>
+</template>
+```
+
+## ⚙️ TypeScript автодополнение
+
+Убедитесь, что `tsconfig.json` содержит:
+
+```json
+{
+  "compilerOptions": {
+    "moduleResolution": "bundler",
+    "paths": {
+      "@soroka282/migrant.ui-kit": ["node_modules/@soroka282/migrant.ui-kit"]
+    }
+  }
+}
+```
+
+## 🎨 Глобальные стили (optional)
+
+В `main.ts`:
+
+```ts
+import '@soroka282/migrant.ui-kit/dist/style.css';
+```
 
-Learn more about the recommended Project Setup and IDE Support in the [Vue Docs TypeScript Guide](https://vuejs.org/guide/typescript/overview.html#project-setup).