Installation • Usage example • Examples • Build Status • Contributing • Thanks • License

badge is a Go package for generating SVG badges.

Installation

Make sure you have a working Go 1.18+ workspace (instructions), then:

go get github.com/essentialkaos/go-badge

Usage example

package main

// ////////////////////////////////////////////////////////////////////////// //

import (
  "fmt"
  "github.com/essentialkaos/go-badge"
)

// ////////////////////////////////////////////////////////////////////////// //

func main() {
  g, err := badge.NewGenerator("Verdana.ttf", 11)

  if err != nil {
    panic(err)
  }

  fmt.Println(string(g.GeneratePlastic("status", "ok", "#97ca00")))
}

Examples

Flat	Flat Square	Plastic	Flat (Simple)	Flat Square (Simple)	Plastic (Simple)

All badges are generated with the latest version of the package.

Build Status

Branch	Status
master
develop

Contributing

Before contributing to this project please read our Contributing Guidelines.

Thanks

We would like to thank:

• All authors and contributors of shields.io service;
• All authors of freetype package;
• @narqo for go-badge package.

License

Apache License, Version 2.0