diff --git a/README.md b/README.md index 302cdb09e..36f0db092 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![OpenYellow](https://img.shields.io/endpoint?url=https://openyellow.neocities.org/badges/2/736878759.json)](https://openyellow.notion.site/openyellow/24727888daa641af95514b46bee4d6f2?p=f78cea2066114067ab9069f06206219d&pm=s)
-Набор библиотек для интеграции с некоторыми популярными API для 1C:Enterprise.
+Набор библиотек для интеграции с некоторыми популярными API для 1C:Enterprise и OneScript

@@ -28,20 +28,27 @@ ## Релизы ## -Релизы библиотеки выходят в трех вариантах: как XML файлы расширения для загрузки через конфигуратор, как EDT проект расширения и как отдельный файл расширения формата cfe. Помимо этого, вы можете просто скопировать код общих модулей из релизов XML или EDT в свою конфигурацию вручную - метаданных других типов там нет. Вне зависимости от выбранного сопособа, получать файлы необходимо из Release, так как в самих исходных файлах репозитория бывают промежуточные данные и функции, находящиеся в процессе разработки. +Релизы библиотеки выходят в четырех вариантах: +- Как XML файлы расширения для загрузки через конфигуратор +- Как EDT проект расширения +- Как отдельный файл расширения формата cfe +- Как OneScript пакет расширения ospx. -Общие модули проекта бывают двух видов: +Помимо этого, вы можете просто скопировать код общих модулей из релизов в свой проект вручную. Однако, вне зависимости от выбранного сопособа установки, получать файлы необходимо из Release, так как в самих исходных файлах репозитория бывают промежуточные данные и функции, находящиеся в процессе разработки. -- Служебные - - OPI_Инструменты - - OPI_Криптография -- Модули непосредственной работы с API - - OPI_Telegram, OPI_VK... - +
+ +Для начала работы в OneScript дополнительно необходимо установить пакет из скачанного ospx файла + +``` + opm install ./OInt-1.0.0.ospx +``` +
+ >[!WARNING] ->Не рекомендуется использовать методы служебных модулей в других местах вашей конфигурации (если вы собираетесь обновляться до новых версий в дальнейшем). Для сохранения обратной совместимости, количество/назначение параметров и типы возвращаемых значений для методов работы с API не изменяются, но это не применимо к служебным модулям, которые могут изменяться как угодно для оптимизации и дополнения под новые нужды. Если вам необходим функционал из служебных модулей, рекомендуется скопировать его себе отдельно. +>Не рекомендуется напрямую использовать методы служебных модулей (OPI_Инструменты, OPI_Криптография) в вашем проекте (если вы собираетесь обновляться до новых версий в дальнейшем). Для сохранения обратной совместимости, количество/назначение параметров и типы возвращаемых значений для методов работы с API не изменяются, но это не применимо к служебным модулям, которые могут изменяться как угодно для оптимизации и дополнения под новые нужды. Если вам необходим функционал из служебных модулей, рекомендуется скопировать его себе отдельно. +
-Список релизов можно найти в [Releases данного репозитория](https://github.com/Bayselonarrend/OpenIntegrations/releases). ## Документация ##