Modified README.md (#8)

README.md

@@ -1,18 +1,28 @@
 # rbkmoney-cms-opencart
 
+Пожалуйста, обязательно делайте бекапы!
+
+Модуль разрабатывался и тестировался на Opencart 2.1.0.2
+
+
+#### Требования
+
+- PHP 5.4 (минимум)
+- OpenSSL - 1.0.2k-fips (минимум)
+- Curl
+
+#### Доступные ставки НДС для корзины
+
+- ничего не указано - без НДС
+- 0 - 0% НДС
+- 10 - 10% НДС
+- 18 - 18% НДС
 
-### На русском
 
 ### Установка и настройка модуля
 
-#### Установка
 
-1. Первый способ
-
-Заархивируйте папку `upload` в `zip` архив и переименуйте его в `rbkmoney-payment.ocmod.zip`
-После чего необходимо зайти в `Extension Installer`, нажать `Upload` и выбрать архив для установки: `rbkmoney-payment.ocmod.zip`
-
-2. Второй способ
+#### Установка без архива
 
 Для установки модуля скопируйте содержимое каталога `upload`:
 
@@ -21,29 +31,86 @@
 <OpenCart>/catalog/
 ```
 
+
+#### Установка с архивом
+
+Заархивируйте папку `upload` в `zip` архив и переименуйте его в `rbkmoney-payment.ocmod.zip`
+
+После чего необходимо зайти в `Extension Installer`
+
+![Extension Installer](images/extension_Installer.png)
+
+нажать `Upload` и выбрать архив для установки: `rbkmoney-payment.ocmod.zip`
+
+![Upload](images/upload.png)
+
+
+
 #### Настройка модуля
 
-Затем в панели администратора установите и настройте его:
+В панели администратора установите и настройте его:
 
 ```
 Extensions > Payments > RBKmoney нажать [Install]
+```
+
+![Payments](images/payments.png)
+
+![Module](images/module.png)
+
+
+#### Для начала приема платежей на Вашем сайте осталось совсем немного
+
+```
 Extensions > Payments > RBKmoney нажать [Edit] и заполнить необходимые настройки
 ```
 
-Для начала приема платежей на Вашем сайте необходимо:
-
-- Зарегистрироваться на https://dashboard.rbk.money
-- Получить необходимые данные для настройки модуля
-- Настроить модуль
-
-#### Совместимость
-
-- Opencart 2.1.0.2
-
-В списке совместимости нет вашей версии Opencart 2.x? Напишите нам обращение - это ускорит процесс адаптации модуля под вашу систему.
+![Settings](images/settings.png)
 
 
-#### Проблемы и решения
+Настройте плагин в соответствии с данными из [личного кабинета RBKmoney](https://dashboard.rbk.money).
+
+`Shop ID` - идентификатор магазина из RBKmoney. Скопируйте его в Личном кабинете RBKmoney в разделе Детали магазина, поле Идентификатор;
+
+`Private key` - ключ для доступа к API. Скопируйте его в Личном кабинете RBKmoney в разделе API Ключ
+
+`Callback public key` - ключ для обработки уведомлений о смене статуса
+
+- Заходим в личный кабинет RBKmoney: Создать Webhook;
+- Вставляем в поле URL вида `http://your-site/index.php?route=payment/rbkmoney_payment/callback`, скопированного из `Notification URL`
+- Выбираем Типы событий `InvoicePaid` и `Invoice Canсelled`;
+- после создания Webhook-а копируем Публичный ключ после нажатия Показать детали;
+- скопированный ключ вставляем в поле `Callback public key` на странице настроек модуля;
+
+
+- Сохраните изменения и проведите тестовый платеж
+
+
+В настройках модуля можно включить или отключить логирование `Advanced settings / Enable logs`
+
+![Advanced settings](images/advanced_settings.png)
+
+C ними можно ознакомиться `Tools / Error logs`
+
+![Tools](images/tools.png)
+
+Выглядит это так:
+
+![Error logs](images/error_logs.png)
+
+
+### Нашли ошибку или у вас есть предложение по улучшению модуля?
+
+Пишите нам support@rbkmoney.com При обращении необходимо:
+
+- Указать наименование CMS и компонента магазина, а также их версии
+- Указать версию платежного модуля
+- Описать проблему или предложение
+- Приложить снимок экрана (для большей информативности)
+
+
+
+#### Возможные проблемы и их решения
 
 1. Ошибка: FTP должен быть включен в настройках
 
@@ -93,98 +160,3 @@ Extensions > Payments > RBKmoney нажать [Edit] и заполнить не
 ```
 ALTER TABLE oc_modification CHANGE xml xml MEDIUMTEXT CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL ;
 ```
-
----
-
-### In English
-
-### Installing and Configuring Module
-
-#### Installation
-
-1. First way
-
-Archive `upload` folder to ` zip` archive and rename it to `rbkmoney-payment.ocmod.zip`
-After that you navigate to `Extension Installer`, click` Upload` and select archive to install: `rbkmoney-payment.ocmod.zip`
-
-2. Second way
-
-To install module, copy contents of `upload` directory:
-
-`` `
-<OpenCart> / admin /
-<OpenCart> / catalog /
-`` `
-
-#### Module configuration
-
-Then in admin panel, install and configure it:
-
-`` `
-Extensions> Payments> RBKmoney click [Install]
-Extensions> Payments> RBKmoney click [Edit] and fill in necessary settings
-`` `
-
-To start accepting payments on your site you need:
-
-- Register on https://dashboard.rbk.money
-- Get necessary data to configure module
-- Module configuration
-
-#### Compatibility
-
-- Opencart 2.1.0.2
-
-Is your version of Opencart 2.x not listed in compatibility list? Write us an appeal - this will speed up the process of adapting the module to your system.
-
-
-#### Problems and solutions
-
-1. Error: FTP must be enabled in settings
-
-Two solutions:
-
-- If installing this module from admin panel displays this error - you need to install free FTP QuickFix modification of localcopy.ocmod.xml. It can be installed without problems through same add-on installer, only after installation do not forget to update modifications and then you can proceed to install any modules on Opencart 2.
-
-- You can also solve this error differently: register FTP accesses in System> Settings> Store> FTP tab.
-
-2. Error: Access is denied!
-
-If you see message "Access Denied! You are not authorized to access this page." If you need it, contact administrator. " - You need to give administrators rights to manage module or page.
-
-Solution: In Opencart 2 admin panel, go to System> Users> User Groups> Administrators and click "Select All" below both blocks, then Save.
-
-3. Error: Invalid file type!
-
-If module is one XML file, then its extension must be .ocmod.xml
-
-If module is an ocmod.zip archive, then it does not need to be unpacked, but installed as it is. In such an archive must necessarily be folder upload (may be empty), and also there may be modification files: install.xml, install.php, install.sql. There should not be any other files in root of archive.
-
-Read more about how to [install modules in Opencart 2] (https://opencart2x.ru/blog/install-module)
-
-
-4. Error: directory containing files for download can not be found!
-
-This error indicates that uploaded archive does not have upload folder. Even if module does not have files other than modifications - this folder should be present in archive of module .ocmod.zip, then it should remain empty.
-
-5. Error: modifier uses same ID code that you are trying to load!
-
-This error means that you are trying to install a modifier that is already installed, or perhaps some of your module has same ID.
-
-To solve this error, you must remove old version of modification in Modules> Modifications section before installing.
-
-If you do not have such a module, but ID is same, then you need to change value of parameter `<code>` in installed XML modifier, to make this parameter unique by adding several characters.
-
-6. Error: Warning: DOMDocument :: loadXML (): CData section not finished`
-
-This error means that you are trying to set a too large xml modifier.
-
-Number of characters in `ocmod.xml` file should not exceed 65535.
-
-To solve error, you need to split xml-file of modification into several parts, main thing - do not forget to set each unique value in `<code>`, you can add figures 1,2,3 ... to current value as part identifiers.
-
-Another way to solve is to change type in fields where modifications are stored in database table `` oc_modification ''. You need to execute following SQL query:
-
-```
-ALTER TABLE oc_modification CHANGE xml xml MEDIUMTEXT CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL ;
-```