You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
badges/README.md

8.0 KiB

PkgGoDev GitHub Actions CI Status GoReportCard Coverage Status Codebeat badge GitHub Actions CodeQL Status

InstallationUsage exampleExamplesBuild StatusContributingThanksLicense


badge is a Go package for generating SVG badges.

Installation

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

go get -d github.com/essentialkaos/go-badge

For update to latest stable release, do:

go get -d -u 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)
flat square plastic flat-simple square-simple plastic-simple
flat square plastic flat-simple square-simple plastic-simple
flat square plastic flat-simple square-simple plastic-simple
flat square plastic flat-simple square-simple plastic-simple
flat square plastic flat-simple square-simple plastic-simple
flat square plastic flat-simple square-simple plastic-simple
flat square plastic flat-simple square-simple plastic-simple
flat square plastic flat-simple square-simple plastic-simple
flat square plastic flat-simple square-simple plastic-simple
flat square plastic flat-simple square-simple plastic-simple
flat square plastic flat-simple square-simple plastic-simple
flat square plastic flat-simple square-simple plastic-simple
flat square plastic flat-simple square-simple plastic-simple
flat square plastic flat-simple square-simple plastic-simple
flat square plastic flat-simple square-simple plastic-simple

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

Build Status

Branch Status
master CI
develop CI

Contributing

Before contributing to this project please read our Contributing Guidelines.

Thanks

We would like to thank:

License

Apache License, Version 2.0