Skip to content

Commit ccda890

Browse files
authored
Improve README.md
1 parent 66ff768 commit ccda890

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Symfony Docker
22

3-
A [Docker](https://www.docker.com/)-based installer and runtime for the [Symfony](https://symfony.com) web framework.
3+
A [Docker](https://www.docker.com/)-based installer and runtime for the [Symfony](https://symfony.com) web framework, with full [HTTP/2](https://symfony.com/doc/current/weblink.html) and HTTPS support.
44

55
## Getting Started
66

@@ -21,13 +21,14 @@ The value must be [a valid Composer stability option](https://getcomposer.org/do
2121

2222
For instance, use the following command to use the `master` branch of Symfony:
2323

24-
`STABILITY=dev docker-compose up --build`
24+
```bash
25+
STABILITY=dev docker-compose up --build
26+
```
2527

2628
## Debugging
2729

28-
The default Docker stack is shipped without a Xdebug stage. It's easy
29-
though to add [Xdebug](https://xdebug.org/) to your project, for development
30-
purposes such as debugging tests or API requests remotely.
30+
The default Docker stack is shipped without a Xdebug stage.
31+
It's easy though to add [Xdebug](https://xdebug.org/) to your project, for development purposes such as debugging tests or API requests remotely.
3132

3233
### Add a Development Stage to the Dockerfile
3334

@@ -48,8 +49,7 @@ RUN set -eux; \
4849

4950
### Configure Xdebug with Docker Compose Override
5051

51-
Using an [override](https://docs.docker.com/compose/reference/overview/#specifying-multiple-compose-files)
52-
file named `docker-compose.override.yaml` ensures that the production
52+
Using an [override](https://docs.docker.com/compose/reference/overview/#specifying-multiple-compose-files) file named `docker-compose.override.yaml` ensures that the production
5353
configuration remains untouched.
5454

5555
As example, an override could look like this:
@@ -76,15 +76,15 @@ services:
7676
PHP_IDE_CONFIG: serverName=symfony-docker
7777
```
7878
79-
And run :
79+
Then run:
80+
8081
````bash
8182
docker-compose -f docker-compose.yaml -f docker-compose.override.yaml up -d
8283
````
8384
8485
### Troubleshooting
8586
86-
Inspect the installation with the following command. The requested Xdebug
87-
version should be displayed in the output.
87+
Inspect the installation with the following command. The requested Xdebug version should be displayed in the output.
8888
8989
```bash
9090
$ docker-compose exec php php --version

0 commit comments

Comments
 (0)