badge

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.16+ 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", 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.

License

Apache License, Version 2.0

Documentation

Overview

Package badge provides methods for generating SVG badges

Index

• Constants
• type Generator
  • func NewGenerator(fontFile string, fontSize int) (*Generator, error)
  • 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
)

const VERSION = "1.3.0"

VERSION is current package version

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

func NewGenerator(fontFile string, fontSize int) (*Generator, error)

NewGenerator creates new badge generator with given font

func (*Generator) GenerateFlat

func (g *Generator) GenerateFlat(label, message, color string) []byte

GenerateFlat generates SVG badge in flat style

func (*Generator) GenerateFlatSimple

func (g *Generator) GenerateFlatSimple(message, color string) []byte

GenerateFlatSimple generates SVG simple badge in flat style

func (*Generator) GenerateFlatSquare

func (g *Generator) GenerateFlatSquare(label, message, color string) []byte

GenerateFlatSquare generates SVG badge in flat-square style

func (*Generator) GenerateFlatSquareSimple

func (g *Generator) GenerateFlatSquareSimple(message, color string) []byte

GenerateFlatSquareSimple generates SVG simple badge in flat-square style

func (*Generator) GeneratePlastic

func (g *Generator) GeneratePlastic(label, message, color string) []byte

GeneratePlastic generates SVG badge in plastic style

func (*Generator) GeneratePlasticSimple

func (g *Generator) GeneratePlasticSimple(message, color string) []byte

GeneratePlasticSimple generates SVG simple badge in plastic style