From 3dedf89b09352589d4b37befaba2d2226b906a58 Mon Sep 17 00:00:00 2001
From: Alexander Zhirov <alexander@zhirov.kz>
Date: Sun, 25 May 2025 03:49:40 +0300
Subject: [PATCH] =?UTF-8?q?=D0=9E=D0=B1=D0=BD=D0=BE=D0=B2=D0=BB=D0=B5?=
 =?UTF-8?q?=D0=BD=D0=B0=20=D0=B8=D0=BD=D1=84=D0=BE=D1=80=D0=BC=D0=B0=D1=86?=
 =?UTF-8?q?=D0=B8=D1=8F=20=D0=BE=D0=B1=20=D0=B8=D1=81=D0=BF=D0=BE=D0=BB?=
 =?UTF-8?q?=D1=8C=D0=B7=D0=BE=D0=B2=D0=B0=D0=BD=D0=B8=D0=B8?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)

diff --git a/README.md b/README.md
index 868928f..e5473f0 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,68 @@
 # snag
 
 Snapshot Git - система резервного копирования на основе фиксации состояния файлов с помощью Git.
+
+## Использование
+
+### Описание файла конфигурации
+
+---
+
+```json
+{
+	"git": "/tmp/testgit",
+	"project": "/tmp/test",
+	"email": "user@site.domain",
+	"user": "snag"
+}
+```
+
+1. **`"git"`**
+	- *Тип:* Строка (путь)
+	- *Назначение:* Указывает расположение Git-репозитория
+
+2. **`"project"`**
+	- *Тип:* Строка (путь)
+	- *Назначение:* Корневая директория для отслеживания состояния файлов
+
+3. **`"email"`**
+	- *Тип:* Строка (email)
+	- *Назначение:* Email автора коммитов в Git
+
+4. **`"user"`**  
+	- *Тип:* Строка
+	- *Назначение:* Имя пользователя для Git-операций
+
+### Описание программы `snag`
+
+---
+
+#### **Общий синтаксис**
+
+```bash
+snag [ОПЦИИ] [ГЛАВНАЯ_КОМАНДА] [ОПЦИИ] [АРГУМЕНТЫ]
+```
+
+---
+
+#### **Основные команды**
+
+| Команда    | Описание                                                                 |
+|------------|--------------------------------------------------------------------------|
+| `restore`  | Восстановить проект до состояния указанного снимка                       |
+| `init`     | Инициализировать репозиторий для хранения снимков                        |
+| `list`     | Показать список доступных снимков                                        |
+| `status`   | Проверить состояние отслеживаемых файлов (изменения с последнего снимка) |
+| `create`   | Создать новый снимок состояния проекта                                   |
+
+---
+
+#### **Флаги и опции**
+
+| Опция               | Описание                                                                 |
+|---------------------|--------------------------------------------------------------------------|
+| `-h`, `--help`      | Показать справку по команде                                              |
+| `--version`         | Показать версию программы                                                |
+| `-c`, `--config`    | Указать путь к файлу конфигурации (необязательно)                        |
+
+---