From d58eb04456ec8aa7955669abbdf30d5ecff51bff Mon Sep 17 00:00:00 2001
From: "S.Gromov" <zz-gromov@ya.ru>
Date: Mon, 26 Jan 2026 20:31:06 +0300
Subject: [PATCH] =?UTF-8?q?feat:=20=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB?=
 =?UTF-8?q?=D0=B5=D0=BD=20=D1=80=D0=B8=D0=B4=D0=BC=D0=B8?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b7e56f7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,54 @@
+# @gromlab/create
+
+CLI-утилита для генерации файлов из шаблонов.
+
+## Использование
+
+```bash
+npx @gromlab/create <шаблон> <имя> [опции]
+```
+
+## Пример
+
+```bash
+# Создать компонент из шаблона
+npx @gromlab/create component Button
+
+# Указать папку вывода
+npx @gromlab/create component Button --out src/components
+
+# Превью без записи
+npx @gromlab/create component Button --dry-run
+```
+
+## Шаблоны
+
+Шаблоны хранятся в папке `.templates/`. Каждая подпапка — отдельный шаблон.
+
+```
+.templates/
+└── component/
+    ├── {{name.pascal}}/
+    │   ├── index.ts
+    │   ├── {{name.pascal}}.tsx
+    │   └── {{name.pascal}}.module.css
+```
+
+### Переменные
+
+В именах файлов и содержимом доступны переменные:
+- `{{name}}` — исходное значение
+- `{{name.pascal}}` — PascalCase
+- `{{name.camel}}` — camelCase
+- `{{name.kebab}}` — kebab-case
+- `{{name.snake}}` — snake_case
+
+## Опции
+
+| Опция | Описание |
+|-------|----------|
+| `--out <путь>` | Папка вывода (по умолчанию: `.`) |
+| `--templates <путь>` | Папка шаблонов (по умолчанию: `.templates`) |
+| `--overwrite` | Перезаписать существующие файлы |
+| `--dry-run` | Показать результат без записи |
+| `--<переменная> <значение>` | Произвольная переменная шаблона |