Categorygithub.com/gjbae1212/go-badge
modulepackage
1.0.1
Repository: https://github.com/gjbae1212/go-badge.git
Documentation: pkg.go.dev

# README

go-badge

license Go Report Card

go-badge is a library to render shield badges to SVG.

This software has been provided as https://github.com/narqo/go-badge at first and it is modified by gjbae1212.

narqo/go-badge that originally was made has licensed under the MIT.

This forked project is following the MIT.

Installation

Using go get

go get github.com/gjbae1212/go-badge

Usage

package main

import (
	"fmt"
	"os"

	"github.com/gjbae1212/go-badge"
)

func main() {
	err := badge.Render("godoc", "reference", "#5272B4", os.Stdout)
	if err != nil {
		panic(err)
	}

	badge, err := badge.RenderBytes("godoc", "reference", "#5272B4")
	if err != nil {
		panic(err)
	}
	fmt.Printf("%s", badge)
}

License

MIT


All the kudos should go to the great Shields.io specification project.

# Packages

No description provided by the author

# Functions

Render renders a badge of the given color, with given subject and status to w.
RenderBytes renders a badge of the given color, with given subject and status to bytes.

# Constants

Standard colors.
Standard colors.
Standard colors.
Standard colors.
Standard colors.
Standard colors.
Standard colors.
Standard colors.
Standard colors.
Standard colors.
Standard colors.

# Variables

ColorScheme contains named colors that could be used to render the badge.

# Type aliases

Color represents color of the badge.