README
¶
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
freetypepackage; - @narqo for
go-badgepackage.
License
Documentation
¶
Overview ¶
Package badge provides methods for generating SVG badges
Index ¶
- Constants
- type Generator
- func (g *Generator) GenerateFlat(label, message, color string) []byte
- func (g *Generator) GenerateFlatSimple(message, color string) []byte
- func (g *Generator) GenerateFlatSquare(label, message, color string) []byte
- func (g *Generator) GenerateFlatSquareSimple(message, color string) []byte
- func (g *Generator) GeneratePlastic(label, message, color string) []byte
- func (g *Generator) GeneratePlasticSimple(message, color string) []byte
Constants ¶
const ( COLOR_BLUE = "#007ec6" COLOR_BRIGHTGREEN = "#4c1" COLOR_GREEN = "#97ca00" COLOR_GREY = "#555" COLOR_LIGHTGREY = "#9f9f9f" COLOR_ORANGE = "#fe7d37" COLOR_RED = "#e05d44" COLOR_YELLOW = "#dfb317" COLOR_YELLOWGREEN = "#a4a61d" COLOR_SUCCESS = "#4c1" COLOR_IMPORTANT = "#fe7d37" COLOR_CRITICAL = "#e05d44" COLOR_INFORMATIONAL = "#007ec6" COLOR_INACTIVE = "#9f9f9f" )
const ( DEFAULT_OFFSET = 9 // default font offset DEFAULT_SPACING = 0 // default letter spacing )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Generator ¶
type Generator struct {
Offset int // Text offset
Spacing float64 // Letter spacing
// contains filtered or unexported fields
}
Generator is badge generator
func NewGenerator ¶
NewGenerator creates new badge generator with given font
func (*Generator) GenerateFlat ¶
GenerateFlat generates SVG badge in flat style
func (*Generator) GenerateFlatSimple ¶ added in v1.2.0
GenerateFlatSimple generates SVG simple badge in flat style
func (*Generator) GenerateFlatSquare ¶
GenerateFlatSquare generates SVG badge in flat-square style
func (*Generator) GenerateFlatSquareSimple ¶ added in v1.2.0
GenerateFlatSquareSimple generates SVG simple badge in flat-square style
func (*Generator) GeneratePlastic ¶
GeneratePlastic generates SVG badge in plastic style
func (*Generator) GeneratePlasticSimple ¶ added in v1.2.0
GeneratePlasticSimple generates SVG simple badge in plastic style
Source Files