Merge tag 'v1.1.0' into development

- Installer
- Example [config file](./example.conf)
- [Changelog](./CHANGELOG.md)

- README.md includes more information

Author: clivewalkden

CHANGELOG.md

@@ -5,8 +5,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [1.1.0] - 2020-07-10
 ### Added
 - Installer
+- Example [config file](./example.conf)
+- [Changelog](./CHANGELOG.md)
+
+### Changed
+- README.md includes more information
+
 
 ## [1.0.0] - 2020-07-09
 ### Added

README.md

@@ -1,12 +1,32 @@
-# Magento 2 Production DB Sync v1.0.0
+# Magento 2 Production DB Sync v1.1.0
 
-A script to copy over a production database to a staging server.
+## About
+A script to copy over a production database to another server, also has the ability to copy across imagery.
 
-## Installation
+Currently the script is configured to attempt Magento 2 and WordPress database migrations and assumes you have your WordPress database details configured in the `magento/app/etc/env.php` file as a second `connection`.
+
+## Requirements
+- You need curl installed locally. 
+- The excellent [n98-magerun2](https://github.com/netz98/n98-magerun2) needs to be installed on both the local machine and the production machine. (Needs to be executable as n98-magerun).
+- MySQL (or equivalent) needs to be installed on both the local machine and the server (obviously).
+- Magento 2 needs to be installed and configured on both the local and the host machine.
+- rsync needs to be installed locally.
+
+## Installing and Updating
 To install or update the script run the following curl script
-```curl -o- https://raw.githubusercontent.com/clivewalkden/bash-magento2-db-sync/development/install.sh | bash```
+```curl -o- https://raw.githubusercontent.com/clivewalkden/bash-magento2-db-sync/v1.1.0/install.sh | bash```
+
+## Usage
+To copy over a production database first get a shell on the system you want to copy the data to. 
+
+> Notes: If using SSH to connect to the host machine make sure you've connected with the -A flag so that your ssh agent is forwarded to allow additional connections. 
+
+Execute the script in your Magento directory
+```
+$ db-sync.sh
+```
 
-You can save a configuration file in the Magento directory to save answering some of the questions.
+You can save a configuration file in the Magento directory to save answering some of the questions. An example is included in this repository [example.conf](./example.conf)
 
 ```bash
 remote_host=cotswoldcollections.com
@@ -18,4 +38,3 @@ remote_backup_dir=/opt/magento/backups
 remote_shared_deployment_dir=/opt/magento/deployment/shared/magento
 ```
 
-| Notes: Make sure you've connected to the host machine with the -A flag so that your ssh agent is forwarded to allow additional connections.

example.conf

@@ -0,0 +1,8 @@
+# Configuration file for db-sync (https://github.com/clivewalkden/bash-magento2-db-sync)
+remote_host=domain.com
+remote_domain=www.domain.com
+remote_port=22
+remote_username=magento
+remote_magento_dir=/opt/magento/magento2
+remote_backup_dir=/opt/magento/backups
+remote_shared_deployment_dir=/opt/magento/deployment/shared/magento

install.sh

@@ -7,7 +7,7 @@ dbsync_install_dir() {
 }
 
 dbsync_latest_version() {
-  echo "v1.0.0"
+  echo "v1.1.0"
 }
 
 #