From 769267b29437363ba16326a05dc942e51c3aff72 Mon Sep 17 00:00:00 2001
From: Mriyam Tamuli <mbtamuli@gmail.com>
Date: Fri, 19 Jan 2018 02:53:47 +0530
Subject: [PATCH] Add updated README

Signed-off-by: Mriyam Tamuli <mbtamuli@gmail.com>
---
 README.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 58 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 5dc5ed2..4016864 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,61 @@
-# Docker-Compose WordPress
+# EasyEngine Docker-Compose WordPress
+<a href="https://rtcamp.com" target="_blank"><img width="150" src="https://easyengine.io/wp-content/uploads/edd/2015/12/easy-engine-logo-2-RS1.png"></a>
 
-### Requirements
+WordPress powered by Docker! Now run WordPress anywhere you can install Docker.
 
-1. [Docker](https://www.docker.com/)
-2. [Docker Compose](https://docs.docker.com/compose/install/)
+## Installing / Getting started
 
-### Examples
-1. [Single Site](single-site) - Single wordpress site
-2. [Multiple Site](multiple-sites) - Multiple separate wordpress sites
-3. [WordPress Multisite](wp-multisite) - WordPress Multisite
+This project depends on
+
+1. [Git](https://git-scm.com/downloads)
+2. [Docker](https://docs.docker.com/engine/installation/)
+3. [Docker Compose](https://docs.docker.com/compose/install/)
+
+_We're working on getting the dependencies installed by the install script. In
+the meantime, please install the dependencies manually._
+
+This project has an installer script that will install it locally.
+
+You can fetch that script, and then execute it locally. It's well documented so that you can read through it and understand what it is doing before you run it.
+
+```shell
+curl -fsSL https://raw.githubusercontent.com/EasyEngine/docker-compose-wordpress/master/scripts/setup -o setup.sh
+bash setup.sh
+```
+
+## Usage
+
+1. Create a WordPress site
+
+```shell
+eev4 create example.com --wp
+```
+
+2. Delete a site
+```shell
+eev4 delete example.com
+```
+
+3. Use wp-cli with a site
+```shell
+eev4 wp example.com theme list
+```
+
+Run `eev4 --help` for all commands.
+
+## Configuration
+
+The sites get created at `/var/www`. You can view and change the configuration
+for any of the sites at `/var/www/SITE/config`
+
+Run `eev4 restart SITE` to load new configuration.
+
+## Contributing
+
+If you'd like to contribute, please fork the repository and use a feature
+branch. Pull requests are warmly welcome.
+
+## Licensing
+
+The code in this project is licensed under MIT license. See [Licence](https://github.com/EasyEngine/docker-compose-wordpress/blob/master/LICENSE)
+for more information.