Skip to content

Commit 56b7f12

Browse files
committed
docs: improve docs
1 parent e02bbca commit 56b7f12

1 file changed

Lines changed: 6 additions & 17 deletions

File tree

README.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -30,34 +30,23 @@ The Ago project is licensed under the [MIT License](https://github.com/php-ago/a
3030

3131
## Contribute
3232
### With Container Engine
33-
If you use a container engine like [🦦 Podman](https://podman.io/) or [🐳 Docker](https://app.docker.com/), here are the steps that you can make:
33+
> [!NOTE]
34+
> If you use [🐳 Docker](https://app.docker.com/) instead of [🦦 Podman](https://podman.io/), just replace `podman-compose` with `docker compose`, and `podman` with `docker` in code examples below.
3435
3536
#### Build an Image
36-
To build an image, navigate to the root of project and run this command for Docker:
37-
```bash
38-
docker compose build app
39-
```
40-
For Podman, run this:
37+
To build an image, navigate to the root of project and run this command:
4138
```bash
4239
podman-compose build app
4340
```
4441

4542
#### Run the Container
46-
To run the container, navigate to the root of and run this command for Docker:
47-
```bash
48-
docker compose run --rm app
49-
```
50-
For Podman, run this:
43+
To run the container, navigate to the root of and run this command:
5144
```bash
5245
podman-compose run --rm app
5346
```
5447

5548
#### Cleanup
56-
After you are done working on a project, you can cleanup and run the command below to remove things like created networks for the current project. For Docker, run this:
57-
```bash
58-
docker compose down
59-
```
60-
For Podman, run this:
49+
After you are done working on a project, you can cleanup and run the command below to remove things like created networks for the current project run this:
6150
```bash
6251
podman-compose down
63-
```
52+
```

0 commit comments

Comments
 (0)