Merge branch 'release/1.0.1'

README.md

@@ -1,12 +1,7 @@
 
-# Наименование вашего приложения
+# ONEC-REPO-CONVERTER
 
-Шаблон описания приложения
-
-Словом **TODO** отмечены места для корректировки
-
-TODO: Здесь должно быть краткое описание приложения
-Зачем оно создано и какие проблемы решает
+Приложение для конвертирования репозитория 1С с исходниками в формате выгрузки конфигуратора в формат EDT.
 
 ## Установка
 
@@ -17,23 +12,17 @@ TODO: Здесь должно быть краткое описание прил
 
 ## Использование
 
-TODO: Кратко, основные тезисы о том как пользоваться вашим приложением
-
-### TODO: Имя первой команды
-
-TODO: Подробное описание команды
-
-Примеры:
+На данный момент приложение предоставляет одну команду `convert`, используя которую можно выполнить операцию по конвертированию репозитория, содержащего исходники конфигурации 1С в формате выгрузки из конфигуратора в формат проекта EDT.
 
-TODO: Несколько примеров запуска команды
+Для использования необходимо указать путь к каталогу, в которм находится исходный репозиторий, который необходимо сконвертировать, и путь к каталогу нового репозитория. `onec-repo-converter` позволяет выполнить конвертацию истории и перенести в новый репозиторий как только конфигурацию, так и другие файлы, находящиеся в репозитории. 
 
-### TODO: Имя следующей команды
+Для больших проектов с длинной историей полезно использовать опцию `squash`, которая выполнит объединение последовательно идущих коммитов одного автора в один.
 
-TODO: Подробное описание команды
+Полный список опций и их назначение можно узнать обративший к справке приложения.
 
-Примеры:
+**Обратите внимание, что конвертирование выполняется с помощью установленного на машине EDT**.
 
-TODO: Несколько примеров запуска команды
+Если в процессе конвертирования произошла ошибка, есть возможность продолжить процесс, передав стартовый хэш коммита (опция `hash`), также эту опцию можно использовать, если не хотите поднимать историю с глубины веков.
 
 ## Лицензии и права