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.
9ee5d262f9 | 2 years ago | |
---|---|---|
.github | 2 years ago | |
testdata | 3 years ago | |
.codebeatsettings | 3 years ago | |
.gitignore | 3 years ago | |
LICENSE | 3 years ago | |
Makefile | 3 years ago | |
README.md | 3 years ago | |
SECURITY.md | 3 years ago | |
badge.go | 3 years ago | |
badge_test.go | 3 years ago | |
go.mod | 3 years ago | |
go.sum | 3 years ago |
README.md
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.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) |
---|---|---|---|---|---|
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.