Skip to content

Commit 386933d

Browse files
update(doc) # - final
1 parent 0d2cdc3 commit 386933d

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -49,22 +49,22 @@ And finally, a simple **RESTful API**, using [Golang](https://golang.org/), [Pos
4949

5050
- [I - Introduction](#i---introduction)
5151
- [II - Table of content](#ii---table-of-content)
52-
- [II - Conventions, templates and labels](#ii---conventions-templates-and-labels)
52+
- [III - Conventions, templates and labels](#iii---conventions-templates-and-labels)
5353
- [A - Commit conventions](#a---commit-conventions)
5454
- [B - Branch naming convention](#b---branch-naming-convention)
5555
- [C - Issue template](#c---issue-template)
5656
- [D - Pull request template](#d---pull-request-template)
5757
- [E - Custom issues labels preset](#e---custom-issues-labels-preset)
58-
- [III - CI/CD, release and container registry](#iii---cicd-release-and-container-registry)
58+
- [IV - CI/CD, release and container registry](#iv---cicd-release-and-container-registry)
5959
- [A - CI](#a---ci)
6060
- [B - CD](#b---cd)
6161
- [C - Release](#c---release)
62-
- [IV - Golang RESTful API](#iv---golang-restful-api)
62+
- [V - Golang RESTful API](#v---golang-restful-api)
6363
- [A - Stack](#a---stack)
6464
- [B - Makefile](#b---makefile)
65-
- [V - License](#v---license)
65+
- [VI - License](#vi---license)
6666

67-
## II - Conventions, templates and labels
67+
## III - Conventions, templates and labels
6868

6969
### A - Commit conventions
7070

@@ -96,7 +96,7 @@ The labels preset is located at [.github/settings.yml](.github/settings.yml).
9696

9797
You can **add, edit or remove** them. To automatically update these labels, you need to **install** the ["Settings" GitHub app](https://github.com/apps/settings), which will **syncs repository settings defined in the file above to your repository**.
9898

99-
## III - CI/CD, release and container registry
99+
## IV - CI/CD, release and container registry
100100

101101
### A - CI
102102

@@ -146,21 +146,21 @@ It consist of:
146146

147147
After that, you can check the release at `https://github.com/<username>/<repository-name>/releases`.
148148

149-
## IV - Golang RESTful API
149+
## V - Golang RESTful API
150150

151-
The project use Docker and Docker Compose to build and run local and distant images in our workspace.
151+
The project use **Docker** and **Docker Compose** to build and run local and distant images in our workspace.
152152

153153
### A - Stack
154154

155-
All the images use the same network, more informations at [docker-compose.yml](docker-compose.yml)
155+
All the images use the **same network**, more informations at [docker-compose.yml](docker-compose.yml)
156156

157157
| CONTAINER | PORT | IMAGE |
158158
| :-------- | :---------- | :------------------------------------------------------- |
159159
| GOLANG | `3333:3333` | [.docker/api/dev.Dockerfile](.docker/api/dev.Dockerfile) |
160160
| ADMINER | `3334:8080` | [.docker/adminer/Dockerfile](.docker/adminer/Dockerfile) |
161161
| POSTGRES | `5432:5432` | [postgres:latest](https://hub.docker.com/_/postgres) |
162162

163-
> Adminer is a GUI that allows us to manage your database by permetting to to create, edit, delete the different entities, tables, etc.
163+
> Adminer is a GUI that allows us to **manage your database** by permetting to to **create, edit, delete** the different entities, tables, etc.
164164
165165
### B - Makefile
166166

@@ -172,28 +172,28 @@ make setup-env start logs
172172

173173
#### `make help` <!-- omit in toc -->
174174

175-
Display informations about other commands.
175+
**Display** informations about other commands.
176176

177177
#### `make setup-env` <!-- omit in toc -->
178178

179-
Copy the sample environment files.
179+
**Copy** the sample environment files.
180180

181181
#### `make start` <!-- omit in toc -->
182182

183-
Up the containers with full cache reset to avoid cache errors.
183+
Up the containers with **full cache reset** to avoid cache errors.
184184

185185
#### `make stop` <!-- omit in toc -->
186186

187-
Down the containers.
187+
**Down** the containers.
188188

189189
#### `make logs` <!-- omit in toc -->
190190

191-
Display and follow the logs.
191+
**Display and follow** the logs.
192192

193193
#### `make lint` <!-- omit in toc -->
194194

195-
Lint the Go files using `gofmt`.
195+
**Lint** the Go files using `gofmt`.
196196

197-
## V - License
197+
## VI - License
198198

199199
Under [MIT](./LICENSE) license.

0 commit comments

Comments
 (0)