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

2.4 KiB

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

InstallationUsage exampleBuild StatusContributingLicense


badge is a Go package for generating SVG badges.

Installation

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

go get -d pkg.re/essentialkaos/go-badge.v1

For update to latest stable release, do:

go get -d -u pkg.re/essentialkaos/go-badge.v1

Usage example

package main

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

import (
  "fmt"
  "pkg.re/essentialkaos/go-badge.v1"
)

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

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

  if err != nil {
    panic(err)
  }

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

Build Status

Branch Status
master CI
develop CI

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0