From a5625620d431f2360c4bd7d252f33e6692923624 Mon Sep 17 00:00:00 2001
From: harshadyeola <harshad.yeola@rtcamp.com>
Date: Tue, 3 Feb 2015 14:38:53 +0530
Subject: [PATCH] Updated README

---
 README.md | 105 ++++++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 83 insertions(+), 22 deletions(-)

diff --git a/README.md b/README.md
index 3a8e1ee5..56237fd1 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,96 @@
+IMPORTANT
+============================================
 
-How To setup this version on your system??
+#### We are looking for [Python Developers] (https://rtcamp.com/careers/python-developer/) to join our team. We offer work from home, so you can join EasyEngine team anywhere! _[Why Python?] (https://rtcamp.com/blog/easyengine-3-roadmap/#whypython)_
+
+---
+
+[![Stories in Ready](https://badge.waffle.io/rtcamp/easyengine.png?label=ready&title=Ready)](https://waffle.io/rtcamp/easyengine)
+[![Stories in Progress](https://badge.waffle.io/rtcamp/easyengine.png?label=in%20progress&title=In%20Progress)](https://waffle.io/rtcamp/easyengine)
+
+<img src="https://d3qt5vpr7p9rgn.cloudfront.net/wp-content/uploads/2013/08/easy-engine-logo-2-RS1.png" alt="EasyEngine Logo" align="right" />
+
+[![Travis Build Status](https://travis-ci.org/rtCamp/easyengine.svg "Travis Build Status")] (https://travis-ci.org/rtCamp/easyengine)
+
+EasyEngine (ee) is a linux shell-script collection, which makes it easy to manage your wordpress sites running on nginx web-server.
+
+**EasyEngine currently supports:**
+
+- Ubuntu 12.04 & 14.04
+- Debian 7
+
+## Quick Start
+
+```bash
+wget -qO ee rt.cx/ee && sudo bash ee     # install easyengine
+sudo ee site create example.com --wp     # Install required packages & setup WordPress on example.com
+```
+
+## Update EasyEngine
+
+
+Update Procedure For EasyEngine
+
+```bash
+wget -qO eeup http://rt.cx/eeup && sudo bash eeup
+```
+
+## More Site Creation Commands
+
+### Standard WordPress Sites
 
 ```bash
-sudo apt-get install python3-pip git
-sudo pip3 install virtualenv
-git clone -b python https://github.com/rtCamp/easyengine.git
-cd easyengine
-virtualenv ./env  --system-site-packages
-source ./env/bin/activate
-sudo pip3 install -r requirements.txt
-sudo python3 setup.py develop
-ee --help
+ee site create example.com --wp                  # install wordpress without any page caching
+ee site create example.com --w3tc                # install wordpress with w3-total-cache plugin
+ee site create example.com --wpsc                # install wordpress with wp-super-cache plugin
+ee site create example.com --wpfc                # install wordpress + nginx fastcgi_cache
 ```
 
-How to install this version on your system??
+### WordPress Multsite with subdirectory
+
 ```bash
-sudo apt-get update
-sudo apt-get -y install python3 python3-apt python3-setuptools python3-dev git
-git clone -b python https://github.com/rtCamp/easyengine.git
-cd easyengine
-sudo python3 setup.py install
-ee --help
+ee site create example.com --wpsubdir            # install wpmu-subdirectory without any page caching
+ee site create example.com --wpsubdir --w3tc     # install wpmu-subdirectory with w3-total-cache plugin
+ee site create example.com --wpsubdir --wpsc     # install wpmu-subdirectory with wp-super-cache plugin
+ee site create example.com --wpsubdir --wpfc     # install wpmu-subdirectory + nginx fastcgi_cache
 ```
 
+### WordPress Multsite with subdomain
+
+```bash
+ee site create example.com --wpsubdomin            # install wpmu-subdomain without any page caching
+ee site create example.com --wpsubdomain --w3tc     # install wpmu-subdomain with w3-total-cache plugin
+ee site create example.com --wpsubdomain --wpsc     # install wpmu-subdomain with wp-super-cache plugin
+ee site create example.com --wpsubdomain --wpfc     # install wpmu-subdomain + nginx fastcgi_cache
+```
+
+### Non-WordPress Sites
+```bash
+ee site create example.com --html     # create example.com for static/html sites
+ee site create example.com --php      # create example.com with php support
+ee site create example.com --mysql    # create example.com with php & mysql support
+```
+
+## Cheatsheet - Site creation
+
+
+|                    |  Single Site  | 	Multisite w/ Subdir  |	Multisite w/ Subdom  |
+|--------------------|---------------|-----------------------|-----------------------|
+| **NO Cache**       |  	  --wp     |	    --wpsubdir       |	     --wpsubdomain      |
+| **WP Super Cache** |	  --wpsc     |	  --wpsubdir --wpsc  |  	--wpsubdomain --wpsc  |
+| **W3 Total Cache** |    --w3tc     |	  --wpsubdir --w3tc  |  	--wpsubdomain --w3tc  |
+| **Nginx cache**    |    --wpfc     |    --wpsubdir --wpfc  |  	--wpsubdomain --wpfc  |
+
 
-EasyEngine 3.x Developement version
+## Useful Links
+- [Documentation] (http://rtcamp.com/easyengine/docs/)
+- [FAQ] (http://rtcamp.com/easyengine/faq/)
+- [Conventions used] (http://rtcamp.com/wordpress-nginx/tutorials/conventions/)
 
+## Donations
 
-Thinking To Contribute???
+[![Donate](https://cloud.githubusercontent.com/assets/4115/5297691/c7b50292-7bd7-11e4-987b-2dc21069e756.png)]  (https://rtcamp.com/donate/?project=easyengine)
 
-refer docs to know more on EasyEngine Developement
+## License
 
-follow instruction from step 3 in Creating cement app
-http://builtoncement.com/2.4/dev/boss_templates.html
+Same [GPL] (http://www.gnu.org/licenses/gpl-2.0.txt) that WordPress uses!