@albank/vue-ui-kit 1.2.0 → 2.0.0-mr.126-devops-90

package/README.md

@@ -1,20 +1,27 @@
-# AebUiKitVue
-
-Инструкция разработки:
-
-1. yarn
-2. yarn storybook
-3. http://localhost:6006/
-
-Инструкция сборки и публикации:
-
-1. yarn build
-2. yarn publish
-
-Инструкция по использованию в проекте:
-
-1. `yarn add @albank/vue-ui-kit` | `npm install @albank/vue-ui-kit`
-2. Импортировать стили `import '@albank/vue-ui-kit/style.css';` в `main.ts`
-3. Импортировать какой-нибудь компонент в приложении `import { Button } from @albank/vue-ui-kit`
-4. Использовать его `<Button>Сохранить<Button>`
-5. Запустить проект (например, `npm start`)
+# AebUiKitVue
+
+Инструкция по разработке:
+
+1. npm ci
+2. npm run storybook
+3. http://localhost:6006/
+
+Инструкция по сборке и публикации:
+
+1. npm run build
+2. npm publish
+
+Инструкция по использованию в проекте:
+
+1. `npm install @albank/vue-ui-kit`
+2. Импортировать стили `import '@albank/vue-ui-kit/style.css';` в `main.ts`
+3. Импортировать какой-нибудь компонент в приложении `import { Button } from @albank/vue-ui-kit`
+4. Использовать его `<Button>Сохранить<Button>` или кебаб-кейсом с префиксом `aeb` `<aeb-button></aeb-button>`
+5. Запустить проект (например, `npm run serve`)
+
+Используемые технологии:
+
+1. Vue 3 (Composition API)
+2. TypeScript 5
+3. Vite 4
+4. SCSS