From 835638a5768a03c2c2e05441efa4f0206fe05448 Mon Sep 17 00:00:00 2001
From: Vladimir Nadulich <g240596448@gmail.com>
Date: Fri, 31 Oct 2025 19:37:56 +0300
Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB=D0=B5?=
 =?UTF-8?q?=D0=BD=D0=BE=20=D0=BE=D0=BF=D0=B8=D1=81=D0=B0=D0=BD=D0=B8=D0=B5?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 Readme.md      | 51 +++++++++++++++++++++++++++++++++++++++++++++++---
 pyproject.toml |  1 +
 2 files changed, 49 insertions(+), 3 deletions(-)

diff --git a/Readme.md b/Readme.md
index 7516b18..fa6eea7 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,4 +1,49 @@
-# Работа с файлом шаблонов кода 1С
+# onec-codetemplate-parser
+
+Библиотека для парсинга файлов шаблонов кода 1С (.st) и работы с ними.
+
+## Установка
+
+```bash
+pip install onec-codetemplate-parser
+```
+
+## Использование библиотеки
+
+```python
+from onec_codetemplate_parser import parse_to_src, render_from_src
+
+# Выгрузка файла в исходники
+parse_to_src("path/to/template.st", "./src")
+
+# Сборка файла из исходников
+render_from_src("path/to/template.st", "./src")
+```
+
+## Использование консольного приложения
+
+Приложение позволяет выполнять основные команды библиотеки в командной строке.
+
+### Основные команды:
+
+```bash
+# Выгрузка файла в исходники
+onec_codetemplate_parser parse path/to/template.st ./src
+
+# Сборка файла из исходников
+onec_codetemplate_parser render path/to/template.st ./src
+
+# Справка о использовании команд
+onec-onec_codetemplate_parser --help
+
+```
+
+
+## Лицензия
+
+MIT
+
+
+
+
 
-- разборка в дерево файлов
-- сборка из дерева файлов
diff --git a/pyproject.toml b/pyproject.toml
index 705b800..b309b52 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -6,6 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "onec_codetemplate_parser"
 version = "0.2.0"
 description = "Парсер шаблонов 1С"
+readme = { file = "README.md", content-type = "text/markdown" }
 authors = [{name = "Vladimir Nadulich", email = "g240596448@gmail.com"}]
 license = {text = "MIT"}
 dependencies = ["typer>=0.20.0"]