fix(readme): add a short comment
All checks were successful
continuous-integration/drone/push Build is passing
All checks were successful
continuous-integration/drone/push Build is passing
This commit is contained in:
parent
ac7df8be2d
commit
9ddfcad356
@ -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())
|
||||
|
||||
|
@ -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 }}
|
Loading…
Reference in New Issue
Block a user