From dd60036cc246e74875fc59074a8671801b0c0ac9 Mon Sep 17 00:00:00 2001 From: Mriyam Tamuli Date: Tue, 12 Jun 2018 18:32:34 +0530 Subject: [PATCH] Add command examples to README Signed-off-by: Mriyam Tamuli --- README.md | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 50 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 81e4b6bd2..5fac12683 100644 --- a/README.md +++ b/README.md @@ -28,4 +28,53 @@ chmod +x /usr/local/bin/ee ## Usage -EasyEngine will currently only run with root privileges. You can run `ee help` or `ee help site` to get all the details about the various commands and subcommands that you can run. +## Basic Commands + +### create +Runs the site creation. + +```bash +ee site create example.com --wp # install wordpress without any page caching +ee site create example.com --wpredis # install wordpress + redis caching +ee site create example.com --wpsubir # install wpmu-subdirectory without any page caching +ee site create example.com --wpsubir --wpredis # install wpmu-subdirectory + redis caching +ee site create example.com --wpsubdom # install wpmu-subdomain without any page caching +ee site create example.com --wpsubdom --wpredis # install wpmu-subdomain + redis caching +``` + +### delete +Deletes an existing EasyEngine site. + +```bash +ee site delete example.com +``` + +### disable +Disables a website. It will stop and remove the docker containers of the website if they are running. + +```bash +ee site disable example.com +``` + +### enable +Enables a website. It will start the docker containers of the website if they are stopped. + +```bash +ee site enable example.com +``` + +### info +Display all the relevant site information, credentials and useful links. + +```bash +ee site info example.com +``` + +### list +Lists the created websites. + +```bash +ee site list +``` + +EasyEngine will currently only run with root privileges. You can run `ee help`, `ee help site` and `ee help site create` to get all the details about the various commands and subcommands that you can run.