mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2024-12-21 01:50:24 +02:00
Update README.md
This commit is contained in:
parent
0e6c12d021
commit
3f3ffa0f7a
40
README.md
40
README.md
@ -17,12 +17,46 @@
|
||||
|
||||
## Релизы ##
|
||||
|
||||
Релизы библиотеки выходят в трех вариантах: XML файлов расширения для загрузки через конфигуратор, EDT проекта расширения и отдельного файла расширения формата cfe. Помимо этого, вы можете просто скопировать код общих модулей из релизов XML или EDT в свою конфигурацию вручную - кроме общих модулей там ничего нет.
|
||||
Релизы библиотеки выходят в трех вариантах: как XML файлы расширения для загрузки через конфигуратор, как EDT проект расширения и как отдельный файл расширения формата cfe. Помимо этого, вы можете просто скопировать код общих модулей из релизов XML или EDT в свою конфигурацию вручную - метаданных других типов там нет. Вне зависимости от выбранного сопособа, получать файлы необходимо из Release, так как в самих исходных файлах репозитория бывают промежуточные данные и функции, находящиеся в процессе разработки.
|
||||
|
||||
Список релизова можно найти в [Releases данного репозитория](https://github.com/Bayselonarrend/OpenIntegrations/releases).
|
||||
Общие модули проекта бывают двух видов:
|
||||
|
||||
- Служебные
|
||||
- OPI_Инструменты
|
||||
- OPI_Криптография
|
||||
- Модули непосредственной работы с API
|
||||
- OPI_Telegram, OPI_VK...
|
||||
|
||||
>[!WARNING]
|
||||
>Не рекомендуется использовать методы служебных модулей в других местах вашей конфигурации (если вы собираетесь обновляться до новых версий в дальнейшем). Для сохранения обратной совместимости, количество/назначение параметров и типы возвращаемых значений для методов работы с API не изменяются, но это не применимо к служебным модулям, которые могут изменяться как угодно для оптимизации и дополнения под новые нужды. Если вам необходим функционал из служебных модулей, рекомендуется скопировать его себе отдельно.
|
||||
|
||||
Список релизов можно найти в [Releases данного репозитория](https://github.com/Bayselonarrend/OpenIntegrations/releases).
|
||||
|
||||
## Документация ##
|
||||
|
||||
У ОПИ есть подробная документация с примерами по адресу [https://opi.neocities.org](https://opi.neocities.org). Там вы можете найти как общие положения о начаел работы с каждым конкретным API, так и описания каждого метода с примерами кода и возвращаемых значений.
|
||||
У ОПИ есть подробная документация с примерами по адресу [https://opi.neocities.org](https://opi.neocities.org). Там вы можете найти как общие положения о начале работы с каждым конкретным API, так и описания каждого метода с примерами кода и возвращаемых значений.
|
||||
|
||||
![Docs](https://github.com/Bayselonarrend/OpenIntegrations/raw/main/Media/docs.png)
|
||||
|
||||
___
|
||||
|
||||
>В проекте используется механизм распаковки zip и gzip vbondarevsky/Connector
|
||||
>
|
||||
>Copyright 2017-2023 Vladimir Bondarevskiy
|
||||
>под Apache License, Version 2.0
|
||||
>
|
||||
>[https://github.com/vbondarevsky/Connector/](https://github.com/vbondarevsky/Connector/)
|
||||
<br>
|
||||
|
||||
>Используются методы HMAC SHA-256 и некоторые другие из БСП
|
||||
>
|
||||
>Copyright (c) 2019, ООО 1С-Софт Все права защищены. Эта программа и сопроводительные материалы предоставляются в соответствии с условиями лицензии Attribution 4.0 International (CC BY 4.0) Текст лицензии доступен по ссылке: [https://creativecommons.org/licenses/by/4.0/legalcode](https://creativecommons.org/licenses/by/4.0/legalcode)
|
||||
<br>
|
||||
|
||||
>Документация создана при помощи Docusaurus
|
||||
>
|
||||
>Copyright (c) Facebook, Inc. and its affiliates.
|
||||
>
|
||||
>[https://github.com/facebook/docusaurus](https://github.com/facebook/docusaurus)
|
||||
|
||||
>Остальной проект распространяется под лицензией MIT
|
||||
|
Loading…
Reference in New Issue
Block a user