From c49070ea6f0cd13a7f9d41731ad0537c349366cd Mon Sep 17 00:00:00 2001
From: Akolzin Dmitry <akolzinvs@gmail.com>
Date: Wed, 13 Jun 2018 16:19:33 +0300
Subject: [PATCH] Update readme

---
 README.md | 67 ++++++++++++++++++++++++++++++++++++++++---------------
 1 file changed, 49 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 8050437..216764c 100644
--- a/README.md
+++ b/README.md
@@ -1,26 +1,57 @@
-# OpenCart Project Template
+Opencart module
+===============
 
-## Getting Started
+Module allows integrate CMS Opencart >= 2.3 with [retailCRM](http://retailcrm.pro)
 
- 1. Create a new project: `composer create-project beyondit/opencart-project-template ./my/project/folder -s dev`
- 2. Copy the `.env.sample` file to `.env` and set the configuration parameters respectively
- 3. Run `bin/robo opencart:setup` and afterwards `bin/robo opencart:run` on command line (`bin/robo opencart:run &` to run in background)
- 4. Open `http://localhost:8000` in your browser
+### Previous versions:
 
-## Robo Commands
+[v1.x](https://github.com/retailcrm/opencart-module/tree/v1.x)
 
- * `bin/robo opencart:setup` : Install OpenCart with configuration set in `.env` file
- * `bin/robo opencart:run`   : Run OpenCart on a php build-in web server on port 8000
- * `bin/robo project:deploy` : Mirror contents of the src folder to the OpenCart test environment
- * `bin/robo project:watch`  : Redeploy after changes inside the src/ folder or the composer.json file
- * `bin/robo project:package`: Package a `build.ocmod.zip` inside the target/ folder
- 
-## Writing Tests
- 
- * Based on the [OpenCart Testing Suite](https://github.com/beyondit/opencart-test-suite) project tests can be written.
- * After successful setup and deployment, tests can be executed by running the `bin/phpunit` command.
- * Two examples inside the `/tests` folder are given, which can be executed as separat Testsuites by `bin/phpunit --testsuite admin-tests` or `bin/phpunit --testsuite catalog-tests`
+[v2.x (2.0, 2.1, 2.2)](https://github.com/retailcrm/opencart-module/tree/v2.2)
 
+#### Features:
 
+* Export orders to retailCRM & fetch changes back
+* Export product catalog into [ICML](http://www.retailcrm.pro/docs/Developers/ICML) format
 
+#### Install
 
+Copy files to the site root
+
+```
+unzip master.zip
+cp -r opencart-module/* /path/to/site/root
+```
+
+#### Setup
+
+* Go to Admin -> Extensions -> Modules -> retailCRM
+* Fill you api url & api key
+* Specify directories matching
+
+#### Getting changes in orders
+
+Add to cron:
+
+```
+*/5 * * * * /usr/bin/php /path/to/opencart/system/cron/history.php >> /path/to/opencart/system/storage/logs/cronjob_history.log 2>&1
+```
+
+#### Setting product catalog export
+
+Add to cron:
+
+```
+* */4 * * * /usr/bin/php /path/to/opencart/system/cron/icml.php >> /path/to/opencart/system/storage/logs/cronjob_icml.log 2>&1
+```
+
+Your export file will be available by following url
+
+```
+http://youropencartsite.com/retailcrm.xml
+```
+
+#### Export existing orders and customers
+
+You want to run this command onecly:
+/usr/bin/php /path/to/opencart/system/cron/export.php