From 9ddfcad356a3d6f45bd16bf37dd88e5e1d5d4050 Mon Sep 17 00:00:00 2001 From: Matthieu 'JP' DERASSE Date: Mon, 3 Oct 2022 19:37:02 +0000 Subject: [PATCH] fix(readme): add a short comment --- helpers/api_types/go_swagger/generate_readme.go | 2 +- templates/go-swagger/Readme.md.tmpl | 14 ++++++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/helpers/api_types/go_swagger/generate_readme.go b/helpers/api_types/go_swagger/generate_readme.go index 59caeb9..f88e9e7 100644 --- a/helpers/api_types/go_swagger/generate_readme.go +++ b/helpers/api_types/go_swagger/generate_readme.go @@ -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()) diff --git a/templates/go-swagger/Readme.md.tmpl b/templates/go-swagger/Readme.md.tmpl index 69120d0..3ffbe3b 100644 --- a/templates/go-swagger/Readme.md.tmpl +++ b/templates/go-swagger/Readme.md.tmpl @@ -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 }} \ No newline at end of file