Skip to content

Commit 07abab2

Browse files
committed
docs: improve readme.md
1 parent a3e6411 commit 07abab2

File tree

1 file changed

+7
-27
lines changed

1 file changed

+7
-27
lines changed

README.md

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

2020
### With Container Engine
21-
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:
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.
2223
2324
#### Build an Image
24-
To build an image, navigate to the root of the project and run this Docker command:
25-
```bash
26-
docker compose build
27-
```
28-
For Podman, run this:
25+
To build an image, navigate to the root of the project and run this command:
2926
```bash
3027
podman-compose build
3128
```
3229

3330
#### Copy `node_modules` Locally
34-
If you need to copy `node_modules` directory from the container to your local machine, run this command for Docker:
35-
```bash
36-
docker cp php-revival-landing:/app/node_modules .
37-
```
38-
For Podman, run this:
31+
If you need to copy `node_modules` directory from the container to your local machine, run this command:
3932
```bash
4033
podman cp php-revival-landing:/app/node_modules .
4134
```
@@ -44,35 +37,22 @@ podman cp php-revival-landing:/app/node_modules .
4437
> `node_modules` is excluded from using volume in [compose.yml](compose.yml) file, that's why you need to copy it manually. It's done to prevent your local modules to be copied to Linux container, since it can create incompatibility issues between operating systems if you don't use Linux.
4538
4639
#### Run the Container
47-
To run a container, navigate to the root of the project and run this Docker command:
48-
```bash
49-
docker compose up -d
50-
```
51-
For Podman, run this:
40+
To run a container, navigate to the root of the project and run this command:
5241
```bash
5342
podman-compose up -d
5443
```
5544

5645
You can visit `http://localhost:3000` to see your documentation.
5746

5847
#### Enter the Container
59-
To enter inside of the container, run this Docker command:
60-
```bash
61-
docker compose exec app sh
62-
```
63-
For Podman, run this:
6448
```bash
6549
podman-compose exec app sh
6650
```
6751

6852
You'll be able to run NPM commands inside of the container.
6953

70-
#### Remove the Container
71-
To stop and remove the container, run this Docker command:
72-
```bash
73-
docker compose down
74-
```
75-
For Podman, run this:
54+
#### Remove and Stop the Container
55+
To stop and remove the container, run this command:
7656
```bash
7757
podman-compose down
7858
```

0 commit comments

Comments
 (0)