Skip to content

Commit ba728bf

Browse files
committed
Merge branch 'develop-v4' into release/v4
2 parents d15407c + 6e3fdbe commit ba728bf

File tree

1 file changed

+21
-35
lines changed

1 file changed

+21
-35
lines changed

README.md

Lines changed: 21 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,22 @@
11
# EasyEngine v4
22

3+
[![Build Status](https://travis-ci.org/EasyEngine/easyengine.svg?branch=release%2Fv4)](https://travis-ci.org/EasyEngine/easyengine)
34
## Requirements
45

56
* Docker
6-
* Docker-Compose
7-
* PHP
87

98
## Installing
109

11-
Once you've verified requirements, download the [easyengine.phar](https://raw.githubusercontent.com/easyengine/easyengine-builds/master/easyengine.phar) file using `wget` or `curl`:
10+
Once you've verified requirements, download the [setup.sh](http://rt.cx/eev4) file using `wget` or `curl` and execute it:
1211

1312
```bash
14-
curl -O https://raw.githubusercontent.com/easyengine/easyengine-builds/master/easyengine.phar
13+
wget rt.cx/eev4 -O ee4-setup && bash ee4-setup
1514
```
1615

17-
Next, check the Phar file to verify that it's working:
16+
If EE was installed successfully, you should see something like this when you run `ee cli version`:
1817

1918
```bash
20-
php easyengine.phar cli info
21-
```
22-
23-
To use EEv4 from the command line by typing `ee4`, make the file executable and move it to somewhere in your PATH. For example:
24-
25-
```bash
26-
chmod +x easyengine.phar
27-
sudo mv easyengine.phar /usr/local/bin/ee4
28-
```
29-
30-
If EE was installed successfully, you should see something like this when you run `ee4 cli version`:
31-
32-
```bash
33-
$ ee4 cli version
19+
$ ee cli version
3420
EE 0.0.1
3521
```
3622

@@ -41,14 +27,14 @@ EE 0.0.1
4127
Creates, lists and deletes WordPress websites.
4228

4329
~~~
44-
ee4 site
30+
ee site
4531
~~~
4632

4733

4834
**EXAMPLES**
4935

5036
# Create simple WordPress website. No parameter flag defaults to --wp
51-
$ ee4 site create site.test
37+
$ ee site create site.test
5238
Success: ee4_nginx-proxy container launched successfully.
5339
Configuring project...
5440
Creating WordPress site site.test...
@@ -72,7 +58,7 @@ ee4 site
7258
7359
Site entry created.
7460

75-
$ ee4 site create site2.test --wpredis --user=admin --pass=admin [email protected] --title="Site by EasyEngine"
61+
$ ee site create site2.test --wpredis --user=admin --pass=admin [email protected] --title="Site by EasyEngine"
7662
Configuring project...
7763
Creating WordPress site site2.test...
7864
Copying configuration files...
@@ -96,13 +82,13 @@ ee4 site
9682
9783
Site entry created.
9884

99-
$ ee4 site list
85+
$ ee site list
10086
List of Sites:
10187

10288
- site.test
10389
- site2.test
10490

105-
$ ee4 site delete site.test
91+
$ ee site delete site.test
10692
[site.test] Docker Containers removed.
10793
[site.test] Disconnected from Docker network nginx-proxy
10894
[site.test] Docker network nginx-proxy removed.
@@ -111,10 +97,10 @@ ee4 site
11197
Removing database entry.
11298
Site site.test deleted.
11399

114-
### ee4 site create
100+
### ee site create
115101

116102
~~~
117-
ee4 site create <site-name> [--wp|--wpredis] [--letsencrypt] [--title=<title>] [--user=<username>] [--pass=<password>] [--email=<email>]
103+
ee site create <site-name> [--wp|--wpredis] [--letsencrypt] [--title=<title>] [--user=<username>] [--pass=<password>] [--email=<email>]
118104
~~~
119105

120106
Creates WordPress site.
@@ -142,45 +128,45 @@ Creates WordPress site.
142128
[--email=<email>]
143129
E-Mail of the WordPress administrator.
144130

145-
### ee4 site list
131+
### ee site list
146132

147133
~~~
148-
ee4 site list
134+
ee site list
149135
~~~
150136

151137
Lists all the sites created by EasyEngine.
152138

153-
### ee4 site delete
139+
### ee site delete
154140

155141
~~~
156-
ee4 site delete <site-name>
142+
ee site delete <site-name>
157143
~~~
158144

159145
Deletes the given site if it was created by EasyEngine.
160146

161-
### ee4 wp
147+
### ee wp
162148

163149
Run all the wp commands for site created by EasyEngine.
164150

165151
~~~
166-
ee4 wp
152+
ee wp
167153
~~~
168154

169155
### Usage
170156

171157
~~~
172-
ee4 wp <site-name> <wp-command>
158+
ee wp <site-name> <wp-command>
173159
~~~
174160

175161
**EXAMPLES**
176162

177-
$ ee4 wp site.test plugin list
163+
$ ee wp site.test plugin list
178164
+---------+----------+-----------+---------+
179165
| name | status | update | version |
180166
+---------+----------+-----------+---------+
181167
| akismet | inactive | available | 4.0.2 |
182168
| hello | inactive | none | 1.6 |
183169
+---------+----------+-----------+---------+
184170

185-
$ ee4 wp site.test user create author1 [email protected] --user_pass=password --role=administrator
171+
$ ee wp site.test user create author1 [email protected] --user_pass=password --role=administrator
186172
Success: Created user 2.

0 commit comments

Comments
 (0)