From f7a0f9a3ae590ef90af11b6eddb75204636a0ba8 Mon Sep 17 00:00:00 2001 From: Akolzin Dmitry Date: Mon, 12 Mar 2018 15:09:59 +0300 Subject: [PATCH] Readme --- README.md | 13 +++++++++++-- README.ru.md | 27 +++++++++++++++++++++++++++ 2 files changed, 38 insertions(+), 2 deletions(-) create mode 100644 README.ru.md diff --git a/README.md b/README.md index 1d5c5b6..135c5c6 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,17 @@ Module allows: * Configure relations between dictionaries of RetailCRM and Magento (statuses, payments, delivery types and etc) * Generate [ICML](http://www.retailcrm.ru/docs/Developers/ICML) (Intaro Markup Language) for catalog loading by RetailCRM -ICML +## ICML By default ICML file is being generated by module every 4 hours. You can find file in the web root folder with name "retailcrm_{{shop_code}}.xml". For example, http://retailcrm.ru/retailcrm_default.xml -This module is compatible with Magento up to version 2.1.6 +## Installing + +1) Unpack the archive with the module in the directory "app/code/Retailcrm/Retailcrm". In the file "app/etc/config.php" in array `modules` add an element `'Retailcrm_Retailcrm' => 1` + +2) Run into your project directory: +```bash +composer require retailcrm/api-client-php ~5.0 +``` + +This module is compatible with Magento up to version 2.2.3 diff --git a/README.ru.md b/README.ru.md new file mode 100644 index 0000000..d69b16a --- /dev/null +++ b/README.ru.md @@ -0,0 +1,27 @@ +Magento module +============== + +Модуль Magento 2 для интеграции с [RetailCRM] (http://www.retailcrm.ru) через [REST API] (http://www.retailcrm.ru/docs/Developers/Index). + +Модуль позволяет: + +* Производить обмен заказами с retailCRM +* Настроить соответствие справочников RetailCRM и Magento (статусы, оплаты, типы доставки и т.д.) +* Создать [ICML] (http://www.retailcrm.ru/docs/Developers/ICML) (Intaro Markup Language) для загрузки каталога товаров в RetailCRM + +## ICML + +По умолчанию ICML-файл генерируется модулем каждые 4 часа. Вы можете найти файл в корневой папке с именем «retailcrm_{{shop_code}}.xml". Например, http://retailcrm.ru/retailcrm_default.xml + +## Ручная установка + +1) Распакуйте архив с модулем в директорию "app/code/Retailcrm/Retailcrm". В файле "app/etc/config.php" в массив `modules` добавьте элемент `'Retailcrm_Retailcrm' => 1` + +2) Выполните в папке проекта: +```bash +composer require retailcrm/api-client-php ~5.0 +``` + +В конфиг `composer.json` вашего проекта будет добавлена библиотека `retailcrm/api-client-php`, которая установится в папку `vendor/`. + +Этот модуль совместим с Magento 2 до версии 2.2.3