Skip to content

Commit 18cb397

Browse files
committed
Update README
1 parent 9ac73b2 commit 18cb397

File tree

1 file changed

+23
-125
lines changed

1 file changed

+23
-125
lines changed

README.md

Lines changed: 23 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -28,152 +28,50 @@ chmod +x /usr/local/bin/ee
2828

2929
## Usage
3030

31-
## Basic Commands
32-
Currently there are three top level commands of `ee`.
33-
* [ee site](#ee-site)
34-
* [ee shell](#ee-shell)
35-
* [ee cli](#ee-cli)
31+
To get started with EasyEngine and create a wordpress site, run
3632

37-
Note: :warning: 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.
38-
39-
### ee site
40-
Contains basic site management commands
41-
42-
`site` command contains following subcommand
43-
* [ee site create](#ee-site-create)
44-
* [ee site delete](#ee-site-delete)
45-
* [ee site disable](#ee-site-disable)
46-
* [ee site enable](#ee-site-enable)
47-
* [ee site info](#ee-site-info)
48-
* [ee site list](#ee-site-list)
49-
* [ee site start](#ee-site-start)
50-
* [ee site stop](#ee-site-stop)
51-
* [ee site restart](#ee-site-restart)
52-
* [ee site reload](#ee-site-reload)
53-
54-
#### ee site create
55-
Runs the site creation.
56-
57-
```bash
58-
ee site create example.com --wp # install wordpress without any page caching
59-
ee site create example.com --wpredis # install wordpress + redis caching
60-
ee site create example.com --wpsubir # install wpmu-subdirectory without any page caching
61-
ee site create example.com --wpsubir --wpredis # install wpmu-subdirectory + redis caching
62-
ee site create example.com --wpsubdom # install wpmu-subdomain without any page caching
63-
ee site create example.com --wpsubdom --wpredis # install wpmu-subdomain + redis caching
6433
```
65-
66-
#### ee site delete
67-
Deletes an existing EasyEngine site.
68-
69-
```bash
70-
ee site delete example.com
34+
ee site create example.com
7135
```
7236

73-
#### ee site disable
74-
Disables a website. It will stop and remove the docker containers of the website if they are running.
37+
Need a wordpress site with caching? Try
7538

76-
```bash
77-
ee site disable example.com
7839
```
79-
80-
#### ee site enable
81-
Enables a website. It will start the docker containers of the website if they are stopped.
82-
83-
```bash
84-
ee site enable example.com
85-
```
86-
87-
#### ee site info
88-
Display all the relevant site information, credentials and useful links.
89-
90-
```bash
91-
ee site info example.com
40+
ee site create example.com --wpredis
9241
```
9342

94-
#### ee site list
95-
Lists the created websites.
96-
97-
```bash
98-
ee site list
99-
```
100-
101-
#### ee site start
102-
Starts containers associated with site.
103-
104-
```bash
105-
ee site start example.com
106-
ee site start example.com --nginx
43+
Need a wordpress multi-site with page cache?
10744
```
108-
109-
#### ee site stop
110-
Stops containers associated with site.
111-
112-
```bash
113-
ee site stop example.com
114-
ee site stop example.com --nginx
45+
ee site create example.com --wpsubdir --wpredis
11546
```
11647

117-
#### ee site restart
118-
Restarts containers associated with site.
119-
120-
```bash
121-
ee site restart example.com
122-
ee site restart example.com --nginx
48+
Want to play around with your new site?
12349
```
124-
125-
#### ee site reload
126-
Reload services in containers without restarting container(s) associated with site.
127-
128-
```bash
129-
ee site reload example.com
130-
ee site reload example.com --nginx
50+
ee shell example.com
13151
```
13252

133-
### ee shell
134-
Gives you a shell where you can manage and interact with your site.
53+
Want to know more? Checkout readme of these commands -
54+
* [site command](https://github.com/EasyEngine/site-command/)
55+
* [shell command](https://github.com/EasyEngine/shell-command/)
13556

136-
```bash
137-
ee shell example.com
138-
```
57+
Note: :warning: 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.
13958

140-
### ee cli
141-
Commands to manage easyengine itself
59+
## Development
14260

143-
`cli` command has following subcommands:
144-
* [ee cli info](#ee-cli-info)
145-
* [ee cli update](#ee-cli-update)
146-
* [ee cli version](#ee-cli-version)
147-
* [ee cli has-command](#ee-cli-has-command)
61+
Development of easyengine is done entirely on GitHub.
14862

149-
#### ee cli info
150-
Print various details about the EE environment.
63+
We've used [wp-cli](https://github.com/wp-cli/wp-cli/) framework as a base and built EasyEngine on top of it.
15164

152-
```bash
153-
ee cli info
154-
```
155-
#### ee cli update
156-
Updates EasyEngine to the latest release.
65+
This repo contains main core of easyengine (the framework).
66+
All top level commands(except `ee cli`) i.e. `ee site`, `ee shell` have their own repos.
15767

158-
```bash
159-
ee cli update
160-
```
161-
#### ee cli version
162-
Print EasyEngine version.
68+
Currently we have following commands which are bundled by default in EasyEngine:
16369

164-
```bash
165-
ee cli version
166-
```
167-
#### ee cli has-command
168-
Detects if a command exists
70+
* [site command](https://github.com/EasyEngine/site-command/)
71+
* [shell command](https://github.com/EasyEngine/shell-command/)
16972

170-
```bash
171-
ee cli has-command site
172-
```
73+
In future, community will be able to make their own packages and commands!
17374

174-
## Tests
75+
## Contributing
17576

176-
EasyEngine is currently using [behat](http://behat.org/) v3.4.x functional tests. The tests for site-command are inside the `features/` directory in the core repository and can be run using
177-
```
178-
vendor/bin/behat
179-
```
77+
We warmheartedly welcome all contributions however and in whatever capacity you can either through Pull Requests or by reporting Issues. You can contribute here or in any of the above mentioned commands repo.

0 commit comments

Comments
 (0)