diff --git a/.github/workflows/reportcard.yml b/.github/workflows/reportcard.yml new file mode 100644 index 0000000..41b127d --- /dev/null +++ b/.github/workflows/reportcard.yml @@ -0,0 +1,3 @@ +uses: afarbos/go-report-card-action@v1 +with: + threshold: '100' \ No newline at end of file diff --git a/README.md b/README.md index 9a891c4..ada8cae 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # Go REST API Boilerplate +[![Author](https://img.shields.io/badge/author-%40nicobistolfi-blue.svg)](https://github.com/nicobistolfi) +![License](https://img.shields.io/badge/license-MIT-green.svg) +[![Go Report Card](https://goreportcard.com/badge/github.com/nicobistolfi/go-rest-api)](https://goreportcard.com/report/github.com/nicobistolfi/go-rest-api) + This repository provides a structured Go project for building scalable APIs. It emphasizes clean architecture, separation of concerns, and ease of testing and deployment. ## Project Structure @@ -69,6 +73,8 @@ Deployment configurations are located in the `deployments/` directory. ## Documentation +Live documentation for this project can be found at [http://go-rest-api.bistol.fi/](http://go-rest-api.bistol.fi/). + To run the documentation locally: 1. Navigate to the `docs/` directory