Skip to content

Commit

Permalink
Update documentation with new badges
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolaasuni-vonage committed Feb 10, 2023
1 parent db9a508 commit cc9b795
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,32 @@

*Go Service Library*

This Open Source project contains a collection of high-quality GO packages.
This Open Source project contains a collection of high-quality GO (golang) packages.

The packages documentation is available at: [https://pkg.go.dev/github.com/nexmoinc/gosrvlib](https://pkg.go.dev/github.com/nexmoinc/gosrvlib)

This package collection forms the base structure for production-ready web-services.

A new service can be generated in seconds by using the command `make project CONFIG=project.cfg`.
The new generated project name, description, etc..., can be set in the CONFIG file.
A new service can be generated by using the command `make project CONFIG=project.cfg`.
The new generated project name, description, etc..., can be set in the file specified via the CONFIG parameter.

Each package follows the same conventions and they can be individually imported in any project.


[![Go Reference](https://pkg.go.dev/badge/github.com/nexmoinc/gosrvlib.svg)](https://pkg.go.dev/github.com/nexmoinc/gosrvlib)
[![check](https://github.com/nexmoinc/gosrvlib/actions/workflows/check.yaml/badge.svg)](https://github.com/nexmoinc/gosrvlib/actions/workflows/check.yaml)
[![Coverage Status](https://coveralls.io/repos/github/nexmoinc/gosrvlib/badge.svg?branch=main)](https://coveralls.io/github/nexmoinc/gosrvlib?branch=main)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=nexmoinc_gosrvlib&metric=coverage)](https://sonarcloud.io/summary/new_code?id=nexmoinc_gosrvlib)
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=nexmoinc_gosrvlib&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=nexmoinc_gosrvlib)
[![Go Report Card](https://goreportcard.com/badge/github.com/nexmoinc/gosrvlib)](https://goreportcard.com/report/github.com/nexmoinc/gosrvlib)
[![Go Reference](https://pkg.go.dev/badge/github.com/nexmoinc/gosrvlib.svg)](https://pkg.go.dev/github.com/nexmoinc/gosrvlib)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nexmoinc_gosrvlib&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=nexmoinc_gosrvlib)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=nexmoinc_gosrvlib&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=nexmoinc_gosrvlib)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=nexmoinc_gosrvlib&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=nexmoinc_gosrvlib)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=nexmoinc_gosrvlib&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=nexmoinc_gosrvlib)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=nexmoinc_gosrvlib&metric=bugs)](https://sonarcloud.io/summary/new_code?id=nexmoinc_gosrvlib)
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=nexmoinc_gosrvlib&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=nexmoinc_gosrvlib)
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=nexmoinc_gosrvlib&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=nexmoinc_gosrvlib)
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=nexmoinc_gosrvlib&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=nexmoinc_gosrvlib)


* **category** Library
* **license** [MIT](https://github.com/nexmoinc/gosrvlib/blob/main/LICENSE)
Expand All @@ -39,10 +50,10 @@ Each package follows the same conventions and they can be individually imported
<a name="quickstart"></a>
## Quick Start

This project includes a Makefile that allows you to test and build the project in a Linux-compatible system with simple commands.
All the artifacts and reports produced using this Makefile are stored in the *target* folder.
This project includes a *Makefile* that allows you to test and build the project in a Linux-compatible system with simple commands.
All the artifacts and reports produced using this *Makefile* are stored in the *target* folder.

All the packages listed in the *resources/docker/Dockerfile* file are required in order to build and test all the library options in the current environment.
All the packages listed in the *resources/docker/Dockerfile.dev* file are required in order to build and test all the library options in the current environment.
Alternatively, everything can be built inside a [Docker](https://www.docker.com) container using the command "make dbuild".

To see all available options:
Expand Down

0 comments on commit cc9b795

Please sign in to comment.