avatar

README

A V A T A R

Create avatars based on names. The colors are chosen based on the first character. You can save to disk ToDisk or send back over HTTP ToHTTP.

Example

package main

import (
	"github.com/ae0000/avatar"
)

func main() {
	avatar.ToDisk("AE", "../ae.png")

    // Which is the same as
    avatar.ToDisk("Andrew Edwards", "../ae.png")
}

You can pass in a single character as well

// Single initial as well..
avatar.ToDisk("Jet", "../j.png")

HTTP example

Using go-chi (highly recommended HTTP router)

package main

import (
	"fmt"
	"net/http"
	"strings"

	"github.com/ae0000/avatar"
	"github.com/go-chi/chi"
)

func main() {
	r := chi.NewRouter()

	// Get the png based on the initials, You would use it like this:
	//    <img src="http://localhost:3000/avatar/ae/png" width="150">
	r.Get("/avatar/{initials}.png", func(w http.ResponseWriter, r *http.Request) {
		initials := chi.URLParam(r, "initials")

		avatar.ToHTTP(initials, w)
	})

	http.ListenAndServe(":3000", r)
}

TODO

• HTTP example
• Caching
• Custom colors
• Add unique colors that are missing (T-Z,0-9)

Documentation

Index

• Variables
• func GetColorByInteger(id int64) string
• func New(s string, width int, mode Mode) ([]byte, error)
• func SetFontFacePath(f string)
• type Mode

Variables

var ErrEmptyInitials = errors.New("empty initials")

var ErrInvalidMode = errors.New("invalid mode")

Functions

func GetColorByInteger

func GetColorByInteger(id int64) string

func New

func New(s string, width int, mode Mode) ([]byte, error)

func SetFontFacePath

func SetFontFacePath(f string)

SetFontFacePath sets the font to do the business with

Types

type Mode

type Mode int

const (
	FirstLetterOfFirstWord    Mode = 1
	FirstTwoLetterOfFirstWord Mode = 2
	FirstLettersOfTwoWords    Mode = 3
)