Skip to content

Commit a4b79cd

Browse files
authored
Update README.md
1 parent ef3b55b commit a4b79cd

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

.github/README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,24 @@
11

22
# NGINX Proxy Automation
33

4-
This project automates the [nginx-proxy](https://github.com/nginx-proxy/nginx-proxy).
5-
We strongly recommend you (:pray: please do!) to read all documentation.
6-
7-
> To access the previous version of this project please access [version 0.4](https://github.com/evertramos/nginx-proxy-automation/tree/v0.4).
4+
## What this project does
85

6+
This script will _power up_ your new server with the [*nginx-proxy*](https://github.com/nginx-proxy/nginx-proxy), where you will be able to host multiple sites,
7+
auto renewing Let´s Encrypt certificates! ❤️
98

10-
## Video Tutorial
11-
12-
I made a 5 minutes tutorial video:
9+
Something like:
1310

14-
[![NGINX-Proxy-Automation](https://img.youtube.com/vi/E9BtHVr_v9I/0.jpg)](https://www.youtube.com/watch?v=E9BtHVr_v9I)
11+
![Web Proxy environment](https://github.com/evertramos/images/raw/master/webproxy.jpg)
1512

16-
## What this project does
13+
We strongly recommend you (please do! 🙏) to read all documentation before starting in production as well as the [nginx-proxy docs](https://github.com/nginx-proxy/nginx-proxy).
1714

18-
This script will set up your server with the *nginx-proxy*, which will enable you to host multiple sites,
19-
auto renewing Let´s Encrypt certificates.
15+
> To access the previous version of this project please access [version 0.4](https://github.com/evertramos/nginx-proxy-automation/tree/v0.4).
2016
21-
Something like:
17+
## Video Tutorial
2218

23-
![Web Proxy environment](https://github.com/evertramos/images/raw/master/webproxy.jpg)
19+
I made a 5 minutes tutorial video to walk you through this project:
2420

21+
[![NGINX-Proxy-Automation](https://img.youtube.com/vi/E9BtHVr_v9I/0.jpg)](https://www.youtube.com/watch?v=E9BtHVr_v9I)
2522

2623
## Prerequisites
2724

@@ -48,7 +45,7 @@ Also, you will need to make sure you have:
4845

4946
## How to use it
5047

51-
1. Clone this repository:
48+
1. Clone this repository **using the option _--recurse-submodules_**:
5249

5350
```bash
5451
$ git clone --recurse-submodules https://github.com/evertramos/nginx-proxy-automation.git proxy

0 commit comments

Comments
 (0)