From fc59130a1ae0117c309d41be59817e0fc54d8e02 Mon Sep 17 00:00:00 2001 From: bruno-chavez Date: Sat, 14 Aug 2021 13:00:38 -0400 Subject: [PATCH] Minor documentation updates --- README.md | 4 ++-- handlers/handler.go | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4237fa2..55dd9ad 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # Description `go-microservice-template` main purpose is to be a starting point -for a REST API in Go. Reducing boilerplate writing and speeding up development of new microservices +for a REST API in Go. Reducing boilerplate writing and speeding up development of new microservices. # How to use 1. Clone repository. @@ -31,7 +31,7 @@ import ( + Optional CORS handling with [rs/cors](https://github.com/rs/cors), see `server/server.go` for how to enable it. # Continuous Integration -`go-microservice-template` currently, it uses Github Actions for linting, testing and building the microservice. Current workflow: +`go-microservice-template` currently uses GitHub Actions for running a CI pipeline containing linting, testing and building the binary and Docker image. Current workflow: + Lints with [golangci-lint](https://github.com/golangci/golangci-lint). + Run unit tests and prints the results with [tparse](https://github.com/mfridman/tparse). diff --git a/handlers/handler.go b/handlers/handler.go index c118fe0..06d3001 100644 --- a/handlers/handler.go +++ b/handlers/handler.go @@ -2,11 +2,11 @@ package handlers // Handler contains all the routes as methods. -// This makes it easy to spread client, secrets, etc between your routes. +// This makes it easy to spread api keys and secrets between your routes. // In case you need to add one of those said common parts, you just need to add them to your struct definition. type Handler struct{} -// NewHandler creates an return a Handler struct +// NewHandler creates and returns a Handler struct func NewHandler() *Handler { return &Handler{} }