Skip to content

Commit

Permalink
Minor documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
bruno-chavez committed Aug 14, 2021
1 parent 03dd32c commit fc59130
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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).
Expand Down
4 changes: 2 additions & 2 deletions handlers/handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -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{}
}

0 comments on commit fc59130

Please sign in to comment.