fix(readme): add a short comment
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Matthieu 'JP' DERASSE 2022-10-03 19:37:02 +00:00
parent ac7df8be2d
commit 9ddfcad356
Signed by: mderasse
GPG Key ID: 55141C777B16A705
2 changed files with 15 additions and 1 deletions

View File

@ -12,7 +12,7 @@ import (
)
// GenerateReadme will generate a readme based on the given config.
// Launched only at project init.
// Launched only at project init or on force.
func (a APIType) GenerateReadme(path string, config *models.Config) error {
log.Debugf("Starting %s - %s", a.GetName(), helpers.GetCurrentFuncName())

View File

@ -1,3 +1,17 @@
# {{ .Config.ProjectName }}
{{ .Config.ProjectDescription }}
## Table of Contents
* [Technologies Used](#technologies-used)
* [Contact](#contact)
## Technologies Used
- [Gouick](https://git.dev.m-and-m.ovh/mderasse/gouick): Toolbox to quickly generate a API using Go-Swagger.
## Contact
Created by [{{ .Config.ProjectContact.Name }}](mailto:{{ .Config.ProjectContact.Email }})
{{- if .Config.ProjectContact.URL }}
**Website:** "{{ .Config.ProjectContact.URL }}"
{{- end }}