From 9ab9dd005d8844de5ac18af95ce7df7d4167b68a Mon Sep 17 00:00:00 2001
From: "S.Gromov" <zz-gromov@ya.ru>
Date: Tue, 27 Jan 2026 16:03:48 +0300
Subject: [PATCH] =?UTF-8?q?docs:=20=D0=B4=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB?=
 =?UTF-8?q?=D0=B5=D0=BD=20=D0=B0=D0=BD=D0=B3=D0=BB=D0=B8=D0=B9=D1=81=D0=BA?=
 =?UTF-8?q?=D0=B8=D0=B9=20README,=20=D0=BE=D0=B1=D0=BD=D0=BE=D0=B2=D0=BB?=
 =?UTF-8?q?=D0=B5=D0=BD=D1=8B=20=D0=B7=D0=B0=D0=B3=D0=BE=D0=BB=D0=BE=D0=B2?=
 =?UTF-8?q?=D0=BA=D0=B8=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC=D0=B5=D0=BD=D1=82?=
 =?UTF-8?q?=D0=B0=D1=86=D0=B8=D0=B8?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md    | 133 ++++++++++++++++++++++++++++++++-------------------
 README_RU.md | 119 +++++++++++++++++++++++++++++++++++++++++++++
 package.json |   2 +-
 3 files changed, 204 insertions(+), 50 deletions(-)
 create mode 100644 README_RU.md

diff --git a/README.md b/README.md
index 08fd7a5..8ac6fe1 100644
--- a/README.md
+++ b/README.md
@@ -1,84 +1,119 @@
-# @gromlab/create
+# Template-based file generator
 
-CLI-утилита для генерации файлов из шаблонов.
+CLI utility for generating files and folder structures from customizable templates.
 
-## Установка
+## Installation
 
-Глобально:
+### Quick Start with npx
 
 ```bash
-npm i -g @gromlab/create
-```
-При запуске CLI проверяет доступность новой версии. Если вы выбираете «нет»,
-повторный запрос появится через 24 часа. Чтобы пропустить проверку, используйте
-флаг `--skip-update`.
-
-## Автодополнение
-
-Установка вместе с автодополнением (одной командой):
-
-**bash**
-```bash
-npm i -g @gromlab/create && create install-autocomplete --shell bash && source ~/.bashrc
+npx @gromlab/create <template> <name>
 ```
 
-**zsh**
+### Global Installation (Recommended)
+Global installation provides the `create` command with **autocomplete** for template names.
+
+**1. Install:**
 ```bash
-npm i -g @gromlab/create && create install-autocomplete --shell zsh && source ~/.zshrc
+npm i -g @gromlab/create && create install-autocomplete
 ```
 
-**fish**
+**2. Reload your shell:**
 ```bash
-npm i -g @gromlab/create && create install-autocomplete --shell fish && exec fish
+# macOS (zsh)
+source ~/.zshrc
+
+# Linux (bash)
+source ~/.bashrc
+
+# Linux (fish)
+exec fish
 ```
 
-
-## Использование
+## Usage
 
 ```bash
-create <шаблон> <имя> [путь] [опции]
+create <template> <name> [path] [options]
 ```
 
-Если `[путь]` не указан, файлы создаются в директории, где запущен CLI.
+If `[path]` is not specified, files are created in the current directory.
 
-## Пример
+## Example
 
 ```bash
-# Создать компонент из шаблона
+# Create a component from template
 create component Button
 
-# Указать папку вывода позиционно
+# Specify output folder positionally
 create component Button src/components
 ```
 
-## Шаблоны
+## Templates
 
-Шаблоны хранятся в папке `.templates/`. Каждая подпапка — отдельный шаблон.
+Templates are stored in the `.templates/` folder at the project root. Each subfolder is a separate template.
+
+### Creating a Template
+
+1. Create a folder in `.templates/` with the template name
+2. Add files and folders using variables in names and content
+3. Variables are enclosed in double curly braces: `{{variable}}`
+
+The number of variables is unlimited — use any names you need.
+
+### Structure
 
 ```
 .templates/
-└── component/
-    ├── {{name.pascal}}/
-    │   ├── index.ts
-    │   ├── {{name.pascal}}.tsx
-    │   └── {{name.pascal}}.module.css
+├── component/
+│   └── {{name.pascalCase}}/
+│       ├── index.ts
+│       ├── {{name.pascalCase}}.tsx
+│       └── {{name.pascalCase}}.module.css
+└── zustand-store/
+    └── {{name.camelCase}}Store/
+        ├── index.ts
+        ├── {{name.camelCase}}Store.ts
+        └── {{name.camelCase}}Store.type.ts
 ```
 
-### Переменные
+### Variables
 
-В именах файлов и содержимом доступны переменные:
-- `{{name}}` — исходное значение
-- `{{name.pascal}}` — PascalCase
-- `{{name.camel}}` — camelCase
-- `{{name.kebab}}` — kebab-case
-- `{{name.snake}}` — snake_case
+Variables are substituted in file/folder names and file contents. You can use any variables in templates — the CLI will prompt for values for all found variables.
 
-Переменная `name` задается только позиционным аргументом `<имя>`. Использование `--name` запрещено.
+- `name` — required variable, set by positional argument
+- Custom variables are passed via flags: `--author "John Doe"`
 
-## Опции
+**Case Modifiers:**
 
-| Опция | Описание |
-|-------|----------|
-| `--overwrite` | Перезаписать существующие файлы |
-| `--skip-update` | Не проверять обновления CLI |
-| `--<переменная> <значение>` | Произвольная переменная шаблона |
+| Syntax | Result for `myButton` |
+|--------|----------------------|
+| `{{name}}` | myButton |
+| `{{name.pascalCase}}` | MyButton |
+| `{{name.camelCase}}` | myButton |
+| `{{name.kebabCase}}` | my-button |
+| `{{name.snakeCase}}` | my_button |
+| `{{name.screamingSnakeCase}}` | MY_BUTTON |
+
+```bash
+# Template with {{name}} and {{author}} variables
+create component Button --author "John Doe"
+```
+
+### Template Content Example
+
+```tsx
+// {{name.pascalCase}}.tsx
+import styles from './{{name.pascalCase}}.module.css'
+
+export const {{name.pascalCase}} = () => {
+  return <div className={styles.wrapper}>{{name.pascalCase}}</div>
+}
+```
+
+## Options
+
+| Option | Description |
+|--------|-------------|
+| `--overwrite` | Overwrite existing files |
+| `--skip-update` | Skip CLI update check |
+| `--<variable> <value>` | Custom template variable |
diff --git a/README_RU.md b/README_RU.md
new file mode 100644
index 0000000..2bc13e4
--- /dev/null
+++ b/README_RU.md
@@ -0,0 +1,119 @@
+# Генератор файлов из шаблонов
+
+CLI-утилита для генерации файлов и структуры папок из настраиваемых шаблонов.
+
+## Установка
+
+### Быстрый запуск через npx
+
+```bash
+npx @gromlab/create <шаблон> <имя>
+```
+
+### Глобальная установка ( Рекомендуется )
+При глобальной установке доступна команда `create` с **автодополнением** имен шаблонов.
+
+**1. Установка:**
+```bash
+npm i -g @gromlab/create && create install-autocomplete
+```
+
+**2. Перезагрузка оболочки:**
+```bash
+# macOS (zsh)
+source ~/.zshrc
+
+# Linux (bash)
+source ~/.bashrc
+
+# Linux (fish)
+exec fish
+```
+
+## Использование
+
+```bash
+create <шаблон> <имя> [путь] [опции]
+```
+
+Если `[путь]` не указан, файлы создаются в директории, где запущен CLI.
+
+## Пример
+
+```bash
+# Создать компонент из шаблона
+create component Button
+
+# Указать папку вывода позиционно
+create component Button src/components
+```
+
+## Шаблоны
+
+Шаблоны хранятся в папке `.templates/` в корне проекта. Каждая подпапка — отдельный шаблон.
+
+### Создание шаблона
+
+1. Создайте папку в `.templates/` с именем шаблона
+2. Добавьте файлы и папки, используя переменные в именах и содержимом
+3. Переменные заключаются в двойные фигурные скобки: `{{переменная}}`
+
+Количество переменных не ограничено — используйте любые имена.
+
+### Структура
+
+```
+.templates/
+├── component/
+│   └── {{name.pascalCase}}/
+│       ├── index.ts
+│       ├── {{name.pascalCase}}.tsx
+│       └── {{name.pascalCase}}.module.css
+└── zustand-store/
+    └── {{name.camelCase}}Store/
+        ├── index.ts
+        ├── {{name.camelCase}}Store.ts
+        └── {{name.camelCase}}Store.type.ts
+```
+
+### Переменные
+
+Переменные подставляются в имена файлов/папок и в содержимое файлов. В шаблоне можно использовать любые переменные — при генерации CLI потребует значения для всех найденных.
+
+- `name` — обязательная переменная, задается позиционным аргументом
+- Произвольные переменные передаются через флаги: `--author "John Doe"`
+
+**Модификаторы регистра:**
+
+| Синтаксис | Результат для `myButton` |
+|-----------|--------------------------|
+| `{{name}}` | myButton |
+| `{{name.pascalCase}}` | MyButton |
+| `{{name.camelCase}}` | myButton |
+| `{{name.kebabCase}}` | my-button |
+| `{{name.snakeCase}}` | my_button |
+| `{{name.screamingSnakeCase}}` | MY_BUTTON |
+
+```bash
+# Шаблон с переменными {{name}} и {{author}}
+create component Button --author "John Doe"
+```
+
+### Пример содержимого шаблона
+
+```tsx
+// {{name.pascalCase}}.tsx
+import styles from './{{name.pascalCase}}.module.css'
+
+export const {{name.pascalCase}} = () => {
+  return <div className={styles.wrapper}>{{name.pascalCase}}</div>
+}
+```
+
+## Опции
+
+| Опция | Описание |
+|-------|----------|
+| `--overwrite` | Перезаписать существующие файлы |
+| `--skip-update` | Не проверять обновления CLI |
+| `--<переменная> <значение>` | Произвольная переменная шаблона |
diff --git a/package.json b/package.json
index 55919e1..8ad78b2 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@gromlab/create",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "Template-based file generator CLI",
   "license": "MIT",
   "publishConfig": {