From dd515492ab7de2d9a87a228fef17c01f8f659c59 Mon Sep 17 00:00:00 2001 From: Akolzin Dmitry Date: Mon, 12 Mar 2018 15:09:59 +0300 Subject: [PATCH] Readme --- README.md | 9 ++++++--- README.ru.md | 15 ++++++++++++++- 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c6ff888..20bf70c 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,18 @@ 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) export file 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://example.org/retailcrm_default.xml ### Manual install - 1) Run into your project root directory: + +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 ``` @@ -25,5 +29,4 @@ composer require retailcrm/api-client-php ~5.0 3) Change `app/etc/config.php` file by adding `'Retailcrm_Retailcrm' => 1` line into `modules` array - This module is compatible with Magento up to version 2.2.3 diff --git a/README.ru.md b/README.ru.md index cd5fc51..f132f94 100644 --- a/README.ru.md +++ b/README.ru.md @@ -1,5 +1,4 @@ Magento module -============== Модуль Magento 2 для интеграции с [retailCRM](http://www.retailcrm.ru). @@ -17,6 +16,19 @@ Magento module 1) Находясь в корневой директории проекта выполните команду: +* Настроить соответствие справочников 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 ``` @@ -28,4 +40,5 @@ composer require retailcrm/api-client-php ~5.0 В конфигурационный файл `composer.json` вашего проекта будет добавлена библиотека [retailcrm/api-client-php](https://github.com/retailcrm/api-client-php), которая будет установлена в директорию `vendor/`. + Этот модуль совместим с Magento 2 до версии 2.2.3