Update README.md

README.md

@@ -1,32 +1,55 @@
-# Phoenix BSL for 1s
+# Phoenix BSL для 1С
 
 **В СТАДИИ РАЗРАБОТКИ, ИСПОЛЬЗУЙТЕ НА СВОЙ СТРАХ И РИСК =)**
 
 ## Описание
 
-Проект позволяет из 1С запускать проверку текста модуля и отформатировать текст модуля 
-с помощью проекта [BSL LS](https://github.com/1c-syntax/bsl-language-server).
+![Превью PhoenixBSL](/images/preview.png)
 
-## Быстрый старт
+Проект позволяет анализировать и форматировать код 1С в конфигураторе. Инстумент основан на проекте [BSL LS](https://github.com/1c-syntax/bsl-language-server).
 
-Запускается ТОЛЬКО НА **Java 11** или через установку **msi**.
+## Установка
 
-Собираем jar файл или берем из релизов (если там есть таковые). Запускаем в консоли:
-```bash
-java -jar /path/to/file/jar
+Установить приложение можно двумя способами:
+* Через msi из релизов или сборок GitHub Action
+* Запустить отдельно jar файл (нужно подготовить каталоги, почти во всех случаях это нужно для тестирования данного проекта).
+
+### Установка msi
+
+1. Качаем из релизов файл msi.
+2. Устанавливаем на компьютере.
+3. Первый раз запускаем под администратором (иначе не работает обработка нажатий кнопок, пока проблема решается).
+
+### Запуск через jar
+
+1. На компьтере должна быть установлена Java не ниже 11 версии. Если нет - устанавливаем.
+2. Создаем новый каталог, из релизов копируем файл jar.
+3. В каталог создаем каталог app, извлекаем в него архив bsl-language-server_win.zip из релизов проекта [BSL LS](https://github.com/1c-syntax/bsl-language-server/releases/latest).
+4. Запускаем jar файл из консоли:
+```cmd
+java -jar phoenix-{version}.jar 
 ```
+где {version} - версия приложения.
+
+Например:
+```cmd
+java -jar phoenix-0.3.3.jar 
+```
+
+## Как пользоваться
+
+После запуска приложения в конфигураторе нажимаем в модуле с кодом:
+* `CTRL` + `I` - анализ кода на замечания.
+* `CTRL` + `K` - форматирование кода.
 
-В 1С:
-* Запуска проверки текста модуля и вывод на экран -> нажимаем `CTRL` + `I`.
-* Отформатировать текст модуля -> нажимаем `CTRL` + `K`.
+Так же стоит отметить, что анализ и форматирование работает по выделенному коду.
 
 ## Разработка
 
-Для доработки проекта, нужно использоваться Java 11.
+Разработка ведется по git flow. В разработке используется платформа JAVA не ниже 11 версии.
 
 ## Развитие
-Есть есть какие то идеи, касаемо проекта -> кидаем в раздел 
-[Issues](https://github.com/otymko/phoenixbsl/issues).
+Идеи, фидбек, баги по проекту кидаем в раздел Досад [Issues](https://github.com/otymko/phoenixbsl/issues).
 
 
 **P.S.** Зачем это, если есть Снегопат, Turboconf, SmartConfigurator и т.п.?