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.
 
 
Nick Dumas e0e3b91576 Don't want to get these mixed up 1 year ago
.github Improve CI workflow 2 years ago
cmd first draft of web interface 1 year ago
fonts/open_sans Don't want to get these mixed up 1 year ago
testdata Use shorthand hex colors if possible 3 years ago
.codebeatsettings First public release 3 years ago
.gitignore first draft of web interface 1 year ago
LICENSE First public release 3 years ago
Makefile first draft of web interface 1 year ago
README.md Minor improvements 2 years ago
SECURITY.md First public release 3 years ago
badge.go Remove version from code 2 years ago
badge_test.go Update copyright header 2 years ago
go.mod first draft of web interface 1 year ago
go.sum first draft of web interface 1 year ago

README.md

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.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)
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