Merge pull request #5 in M2E/magento-2---mysql-cluster from readme to…

… master

* commit '782b7ff82756bbf350835fd31f16d7221489b397':
  Described Installation Process

README.md

@@ -1 +1,29 @@
-# skynix Magento 2 MySQL Cluster
+## Skynix Magento 2 MySQL Cluster
+# Installation Instructions
+
+1. composer require skynix/m2-mysql-cluster
+2. add configuration into app/etc/env.php
+
+Section db -> connection -> default
+
+add a new section:
+
+'slave-servers' =>
+   [
+      0 =>
+          [
+                          'host' => '<mysql_slave_server>',
+                          'dbname' => '<mysql_slave_db_name>',
+                          'username' => '<mysql_user_name>',
+                          'password' => '<mysql_user_pass>',
+                          'model' => 'mysql4',
+                          'engine' => 'innodb',
+                          'initStatements' => 'SET NAMES utf8;',
+                          'active' => '1',
+           ]
+   ]
+
+Add there as many slave servers as you have.
+
+3. bin/magento deploy:mode:set production
+

composer.json

@@ -2,7 +2,7 @@
     "name": "skynix/m2-mysql-cluster",
     "type": "library",
     "license": "OSL-3.0",
-    "description": "Test",
+    "description": "Magento 2 CE SQL cluster enabled Magento 2 CE to work with database replication",
     "keywords": ["magento2"],
     "authors": [
         {