diff --git a/README.md b/README.md index 5ba61cb..8366488 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,36 @@ Prestashop module ================= -Модуль интеграции CMS Prestashop c [RetailCRM](http://www.retailcrm.com) +Module allows integrate CMS Prestashop with [RetailCRM](http://www.retailcrm.pro) -Модуль позволяет: +#### Features: -* Экспортировать в CRM данные о заказах и клиентах и получать обратно изменения по этим данным -* Синхронизировать справочники (способы доставки и оплаты, статусы заказов и т.п.) -* Выгружать каталог товаров в формате [ICML](http://retailcrm.ru/docs/Разработчики/ФорматICML) (IntaroCRM Markup Language) +* Export orders to retailCRM & fetch changes back +* Export product catalog into [ICML](http://www.retailcrm.pro/docs/Developers/ICML) format -###Установка +#### Setup -#####Скачайте модуль +* Go to module setup page +* Fill you api url & api key +* Specify directories matching -[Cкачать](http://download.retailcrm.pro/modules/prestashop/retailcrm-2.0.zip) +#### Setting product catalog export -#####Установите через административный интерфейс управления модулями. - -![Установка модуля](/docs/images/add.png) - - -###Настройка - -#####Перейдите к настройкам - -![Настройка модуля](/docs/images/setup.png) - -#####Введите адрес и API ключ вашей CRM и задайте соответствие справочников - -![Справочники](/docs/images/ref.png) - - -#####Регулярная генерация выгрузки каталога - -Добавьте в крон запись вида +Add to cron: ``` * */4 * * * /usr/bin/php /path/to/your/site/modules/retailcrm/job/icml.php ``` -#####Регулярное получение изменение из RetailCRM +#### Getting changes in orders -Добавьте в крон запись вида +Add to cron: ``` */7 * * * * /usr/bin/php /path/to/your/site/modules/retailcrm/job/sync.php ``` -#####Единоразовая выгрузка архива клиентов и заказов в RetailCRM +#### Single orders archive export to RetailCRM ``` /usr/bin/php /path/to/your/site/modules/retailcrm/job/export.php diff --git a/README.ru.md b/README.ru.md new file mode 100644 index 0000000..7d6e01e --- /dev/null +++ b/README.ru.md @@ -0,0 +1,36 @@ +Prestashop module +================= + +Модуль интеграции CMS Prestashop c [RetailCRM](http://www.retailcrm.com) + +#### Модуль позволяет: + +* Экспортировать в CRM данные о заказах и клиентах и получать обратно изменения по этим данным +* Синхронизировать справочники (способы доставки и оплаты, статусы заказов и т.п.) +* Выгружать каталог товаров в формате [ICML](http://retailcrm.ru/docs/Разработчики/ФорматICML) (IntaroCRM Markup Language) + +#### Настройка + +На странице настроек модуля введите API url и API ключ, после этого установите соответствие справочников + +#### Выгрузка каталога + +Добавьте в крон запись вида + +``` +* */4 * * * /usr/bin/php /path/to/your/site/modules/retailcrm/job/icml.php +``` + +#### Получение изменение из RetailCRM + +Добавьте в крон запись вида + +``` +*/7 * * * * /usr/bin/php /path/to/your/site/modules/retailcrm/job/sync.php +``` + +#### Единоразовая выгрузка архива клиентов и заказов в RetailCRM + +``` +/usr/bin/php /path/to/your/site/modules/retailcrm/job/export.php +``` diff --git a/docs/images/add.png b/docs/images/add.png deleted file mode 100644 index c518ef5..0000000 Binary files a/docs/images/add.png and /dev/null differ diff --git a/docs/images/ref.png b/docs/images/ref.png deleted file mode 100644 index ac8b229..0000000 Binary files a/docs/images/ref.png and /dev/null differ diff --git a/docs/images/setup.png b/docs/images/setup.png deleted file mode 100644 index 99c7fc9..0000000 Binary files a/docs/images/setup.png and /dev/null differ