indicator-ui 0.0.1

package/README.md

@@ -0,0 +1,67 @@
+# **INDICATOR UI** 🚀
+
+## 📌 Для разработки
+
+---
+
+### 🔥 Точки входа
+
+В проекте есть два ключевых входа для модулей — **js/ts** и **scss**.
+
+#### 📂 `src/index.ts` (js/ts модули)
+
+Добавляем сюда все модули, которые должны быть доступны через:
+```ts
+import {} from 'indicator-ui';
+```
+
+#### 🎨 `src/index.scss` (scss модули)
+
+Добавляем сюда все стили, которые должны быть доступны через:
+```scss
+@use 'indicator-ui' as *;
+```
+
+---
+
+### ⚙️ Сборка проекта
+
+Чтобы собрать проект, используйте:
+
+```sh
+npm run build
+```
+
+Результаты сборки появятся в папке `dist`. Там, возможно, живёт магия. 🧙‍♂️✨
+
+---
+
+## 🛠 Тестирование перед публикацией
+
+Перед публикацией можно протестировать библиотеку на локальном **React**-проекте `test-project`. Для этого используется **yalc** — аналог npm, но для локальных пакетов. 🛞
+
+### 🚀 Установка `yalc`
+
+```sh
+npm install -g yalc
+```
+
+### 📦 Публикация в локальное хранилище
+
+```sh
+yalc publish
+```
+
+### 📥 Установка библиотеки в проект
+
+```sh
+yalc add indicator-ui
+```
+
+### 🔄 Обновление библиотеки
+
+```sh
+yalc update
+```
+
+```yalc publish --push```