@atme-lab/ui-kit 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +70 -63
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,22 +1,29 @@
1
1
  # @atme-lab/ui-kit
2
2
 
3
- Библиотека компонентов для личных проектов
3
+ Component library for personal projects
4
4
 
5
- ## Установка
5
+ > [Read in Russian](docs/README.ru.md)
6
+
7
+ ## Installation
6
8
 
7
9
  ```bash
8
10
  pnpm add @atme-lab/ui-kit
9
- # или
11
+ # or
10
12
  npm install @atme-lab/ui-kit
11
- # или
13
+ # or
12
14
  yarn add @atme-lab/ui-kit
13
15
  ```
14
16
 
15
- ## Быстрый старт
17
+ ## Quick Start
16
18
 
17
19
  ```tsx
18
- import { ThemeProvider, lightTheme, Button, Typography } from "@atme-lab/ui-kit";
19
- // Импортируйте глобальные стили в корне вашего приложения
20
+ import {
21
+ ThemeProvider,
22
+ lightTheme,
23
+ Button,
24
+ Typography,
25
+ } from "@atme-lab/ui-kit";
26
+ // Import global styles at the root of your application
20
27
  import "@atme-lab/ui-kit/global";
21
28
 
22
29
  function App() {
@@ -29,41 +36,41 @@ function App() {
29
36
  }
30
37
  ```
31
38
 
32
- **Важно**: Глобальные стили (`@atme-lab/ui-kit/global`) нужно импортировать один раз в корне вашего приложения (например, в `main.tsx` или `App.tsx`). Они содержат CSS reset и базовые стили для элементов.
39
+ **Important**: Global styles (`@atme-lab/ui-kit/global`) should be imported once at the root of your application (e.g., in `main.tsx` or `App.tsx`). They contain CSS reset and base styles for elements.
33
40
 
34
- ## Документация компонентов
41
+ ## Component Documentation
35
42
 
36
- Детальная документация по всем компонентам, их пропсам и примерам использования доступна в **Storybook**.
43
+ Detailed documentation for all components, their props, and usage examples is available in **Storybook**.
37
44
 
38
- Для локального просмотра документации:
45
+ To view documentation locally:
39
46
 
40
47
  ```bash
41
48
  pnpm storybook
42
49
  ```
43
50
 
44
- Или используйте онлайн-документацию (если доступна).
51
+ Or use the online documentation (if available).
45
52
 
46
- ## Использование тем
53
+ ## Using Themes
47
54
 
48
- Библиотека предоставляет две готовые темы: `lightTheme` и `darkTheme`. Вы можете использовать любую из них или создать свою кастомную тему.
55
+ The library provides two ready-made themes: `lightTheme` and `darkTheme`. You can use either of them or create your own custom theme.
49
56
 
50
- ### Светлая тема
57
+ ### Light Theme
51
58
 
52
59
  ```tsx
53
60
  import { ThemeProvider, lightTheme } from "@atme-lab/ui-kit";
54
61
 
55
- <ThemeProvider theme={lightTheme}>{/* Ваши компоненты */}</ThemeProvider>;
62
+ <ThemeProvider theme={lightTheme}>{/* Your components */}</ThemeProvider>;
56
63
  ```
57
64
 
58
- ### Темная тема
65
+ ### Dark Theme
59
66
 
60
67
  ```tsx
61
68
  import { ThemeProvider, darkTheme } from "@atme-lab/ui-kit";
62
69
 
63
- <ThemeProvider theme={darkTheme}>{/* Ваши компоненты */}</ThemeProvider>;
70
+ <ThemeProvider theme={darkTheme}>{/* Your components */}</ThemeProvider>;
64
71
  ```
65
72
 
66
- ### Кастомная тема
73
+ ### Custom Theme
67
74
 
68
75
  ```tsx
69
76
  import { ThemeProvider, lightTheme, mergeTheme } from "@atme-lab/ui-kit";
@@ -76,47 +83,47 @@ const customTheme = mergeTheme(lightTheme, {
76
83
  },
77
84
  });
78
85
 
79
- <ThemeProvider theme={customTheme}>{/* Ваши компоненты */}</ThemeProvider>;
86
+ <ThemeProvider theme={customTheme}>{/* Your components */}</ThemeProvider>;
80
87
  ```
81
88
 
82
- ## Доступные компоненты
89
+ ## Available Components
83
90
 
84
- Библиотека включает следующие категории компонентов:
91
+ The library includes the following component categories:
85
92
 
86
- - **Primitives**: Button, Typography, Tag и другие базовые компоненты
87
- - **Form**: Input, Select, Checkbox, Radio и другие компоненты форм
88
- - **Feedback**: Alert, Toast, Modal, Tooltip и другие компоненты обратной связи
89
- - **Layout**: Card, Container, Stack, Grid и другие компоненты раскладки
90
- - **Navigation**: Tabs, Menu, Breadcrumb и другие навигационные компоненты
93
+ - **Primitives**: Button, Typography, Tag, and other base components
94
+ - **Form**: Input, Select, Checkbox, Radio, and other form components
95
+ - **Feedback**: Alert, Toast, Modal, Tooltip, and other feedback components
96
+ - **Layout**: Card, Container, Stack, Grid, and other layout components
97
+ - **Navigation**: Tabs, Menu, Breadcrumb, and other navigation components
91
98
 
92
- Полный список компонентов и примеры использования смотрите в Storybook документации.
99
+ See the Storybook documentation for a complete list of components and usage examples.
93
100
 
94
- ## Разработка
101
+ ## Development
95
102
 
96
103
  ```bash
97
- # Установка зависимостей
104
+ # Install dependencies
98
105
  pnpm install
99
106
 
100
- # Запуск Storybook
107
+ # Run Storybook
101
108
  pnpm storybook
102
109
 
103
- # Запуск тестов
110
+ # Run tests
104
111
  pnpm test
105
112
 
106
- # Сборка
113
+ # Build
107
114
  pnpm build
108
115
 
109
- # Линтинг
116
+ # Linting
110
117
  pnpm lint
111
118
  ```
112
119
 
113
- ## Версионирование
120
+ ## Versioning
114
121
 
115
- Проект использует [Conventional Commits](https://www.conventionalcommits.org/) для автоматического версионирования и генерации CHANGELOG.
122
+ The project uses [Conventional Commits](https://www.conventionalcommits.org/) for automatic versioning and CHANGELOG generation.
116
123
 
117
- ### Формат коммитов
124
+ ### Commit Format
118
125
 
119
- Все коммиты должны следовать формату Conventional Commits:
126
+ All commits should follow the Conventional Commits format:
120
127
 
121
128
  ```
122
129
  <type>: <subject>
@@ -127,63 +134,63 @@ pnpm lint
127
134
  ```
128
135
 
129
136
  **Breaking changes:**
130
- Для major версии добавьте `BREAKING CHANGE:` в footer коммита или используйте `!` после типа: `feat!: breaking change`
137
+ For major version, add `BREAKING CHANGE:` in the commit footer or use `!` after the type: `feat!: breaking change`
131
138
 
132
- ### Создание коммитов
139
+ ### Creating Commits
133
140
 
134
- **Рекомендуемый способ** (интерактивный):
141
+ **Recommended way** (interactive):
135
142
 
136
143
  ```bash
137
144
  pnpm commit
138
145
  ```
139
146
 
140
- Или используйте обычный git commit с правильным форматом:
147
+ Or use regular git commit with the correct format:
141
148
 
142
149
  ```bash
143
- git commit -m "feat: добавил компонент Button"
144
- git commit -m "fix: исправил стили в Input"
150
+ git commit -m "feat: add Button component"
151
+ git commit -m "fix: correct Input styles"
145
152
  ```
146
153
 
147
- ### Создание релиза
154
+ ### Creating a Release
148
155
 
149
- Для создания релиза используйте:
156
+ To create a release, use:
150
157
 
151
158
  ```bash
152
- # Автоматическое определение версии на основе коммитов
159
+ # Automatic version detection based on commits
153
160
  pnpm release
154
161
 
155
- # Принудительный minor релиз
162
+ # Force minor release
156
163
  pnpm release:minor
157
164
 
158
- # Принудительный major релиз
165
+ # Force major release
159
166
  pnpm release:major
160
167
  ```
161
168
 
162
- Команда `pnpm release` автоматически:
169
+ The `pnpm release` command automatically:
163
170
 
164
- 1. Анализирует коммиты с момента последнего релиза
165
- 2. Определяет версию (patch/minor/major) на основе типов коммитов
166
- 3. Обновляет `package.json` с новой версией
167
- 4. Генерирует/обновляет `CHANGELOG.md`
168
- 5. Создает git tag (например, `v1.1.0`)
169
- 6. Создает коммит с изменениями
171
+ 1. Analyzes commits since the last release
172
+ 2. Determines the version (patch/minor/major) based on commit types
173
+ 3. Updates `package.json` with the new version
174
+ 4. Generates/updates `CHANGELOG.md`
175
+ 5. Creates a git tag (e.g., `v1.1.0`)
176
+ 6. Creates a commit with the changes
170
177
 
171
- После создания релиза:
178
+ After creating a release:
172
179
 
173
180
  ```bash
174
- # Отправка изменений и тегов
181
+ # Push changes and tags
175
182
  git push --follow-tags
176
183
 
177
- # Публикация в npm (если нужно)
184
+ # Publish to npm (if needed)
178
185
  npm publish
179
186
  ```
180
187
 
181
188
  ### Workflow
182
189
 
183
- 1. **Разработка**: Создавайте коммиты с правильным форматом (используйте `pnpm commit` для упрощения)
184
- 2. **Релиз**: Запустите `pnpm release` когда готовы создать релиз
185
- 3. **Публикация**: Отправьте изменения и теги, затем опубликуйте в npm (если нужно)
190
+ 1. **Development**: Create commits with the correct format (use `pnpm commit` for convenience)
191
+ 2. **Release**: Run `pnpm release` when ready to create a release
192
+ 3. **Publishing**: Push changes and tags, then publish to npm (if needed)
186
193
 
187
- ## Лицензия
194
+ ## License
188
195
 
189
196
  MIT
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@atme-lab/ui-kit",
3
- "version": "0.1.2",
4
- "description": "Modern, scalable React UI library with TypeScript",
3
+ "version": "0.1.4",
4
+ "description": "Component library for personal projects",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
7
7
  "module": "./dist/index.esm.js",