Skip to content

Commit cb4b4fb

Browse files
committed
docs: improve README.md file
1 parent 877835c commit cb4b4fb

1 file changed

Lines changed: 31 additions & 7 deletions

File tree

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,42 +18,66 @@ npm run dev
1818
Navigate to `http://localhost:3000` to see your documentation.
1919

2020
### With Container Engine
21-
> [!NOTE]
22-
> 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.
23-
2421
#### Build an Image
25-
To build an image, navigate to the root of the project and run this command:
22+
To build an image, navigate to the root of the project and run this command. With Podman:
2623

2724
```bash
2825
podman-compose build
2926
```
3027

28+
With Docker:
29+
30+
```bash
31+
docker compose build
32+
```
33+
3134
#### Create `node_modules`
32-
Run this command to install npm packages and generate a `node_modules` directory on your local machine:
35+
Run this command to install npm packages and generate a `node_modules` directory on your local machine. With Podman:
3336

3437
```bash
3538
podman-compose run --rm app npm i
3639
```
3740

41+
With Docker:
42+
```bash
43+
docker compose run --rm app npm i
44+
```
45+
3846
#### Run the Container
39-
To run a container, navigate to the root of the project and run this command:
47+
To run a container, navigate to the root of the project and run this command. With Podman:
4048

4149
```bash
4250
podman-compose up -d
4351
```
4452

53+
With Docker:
54+
```bash
55+
docker compose up -d
56+
```
57+
4558
You can visit `http://localhost:3000` to see your documentation.
4659

4760
#### Enter the Container
61+
With Podman:
4862
```bash
4963
podman-compose exec app sh
5064
```
5165

66+
With Docker:
67+
```bash
68+
docker compose exec app sh
69+
```
70+
5271
You'll be able to run NPM commands inside of the container.
5372

5473
#### Remove and Stop the Container
55-
To stop and remove the container, run this command:
74+
To stop and remove the container, run this command. With Podman:
5675

5776
```bash
5877
podman-compose down
5978
```
79+
80+
With Docker:
81+
```bash
82+
docker compose down
83+
```

0 commit comments

Comments
 (0)