Skip to content

Commit 36b6087

Browse files
committed
docs: format README.md
1 parent 24fb3ca commit 36b6087

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ Navigate to `http://localhost:5173` to see your documentation if you run project
1717

1818
### With Container Engine
1919
#### Build an Image
20-
To build an image, navigate to the root of the project and run this command. With Podman:
20+
To build an image, navigate to the root of the project and run this command.
2121

22+
With Podman:
2223
```bash
2324
podman-compose build
2425
```
@@ -29,8 +30,9 @@ docker compose build
2930
```
3031

3132
#### Create `node_modules`
32-
Run this command to install npm packages and generate a `node_modules` directory on your local machine. With Podman:
33+
Run this command to install npm packages and generate a `node_modules` directory on your local machine.
3334

35+
With Podman:
3436
```bash
3537
podman-compose run --rm app npm i
3638
```
@@ -41,8 +43,9 @@ docker compose run --rm app npm i
4143
```
4244

4345
#### Run the Container
44-
To run a container, navigate to the root of the project and run this command. With Podman:
46+
To run a container, navigate to the root of the project and run this command.
4547

48+
With Podman:
4649
```bash
4750
podman-compose up -d
4851
```
@@ -55,8 +58,9 @@ docker compose up -d
5558
You can visit `http://localhost:3000` to see your documentation.
5659

5760
#### Enter the container
58-
To enter inside of the container, run this command. With Podman:
61+
To enter inside of the container, run this command.
5962

63+
With Podman:
6064
```bash
6165
podman-compose exec app sh
6266
```
@@ -69,14 +73,14 @@ docker compose exec app sh
6973
You'll be able to run NPM commands inside of the container.
7074

7175
#### Stop the container
72-
After you are done working, run this to cleanup containers. With Podman:
76+
After you are done working, run this to cleanup containers.
7377

78+
With Podman:
7479
```bash
7580
podman-compose down
7681
```
7782

7883
With Docker:
79-
8084
```bash
8185
docker compose down
8286
```

0 commit comments

Comments
 (0)