cameron

package module
Version: v1.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 3, 2022 License: MIT Imports: 4 Imported by: 2

README

Cameron

GitHub Actions codecov Go Report Card PkgGoDev

An avatar generator for Go.

Oh, by the way, the name of this project came from the Avatar's director James Cameron.

Features

Installation

Open your terminal and execute

$ go get github.com/aofei/cameron

done.

The only requirement is the Go, at least v1.13.

Quick Start

Create a file named cameron.go

package main

import (
	"bytes"
	"image/png"
	"net/http"

	"github.com/aofei/cameron"
)

func main() {
	http.ListenAndServe("localhost:8080", http.HandlerFunc(identicon))
}

func identicon(rw http.ResponseWriter, req *http.Request) {
	buf := bytes.Buffer{}
	png.Encode(&buf, cameron.Identicon([]byte(req.RequestURI), 540, 60))
	rw.Header().Set("Content-Type", "image/png")
	buf.WriteTo(rw)
}

and run it

$ go run cameron.go

then visit http://localhost:8080 with different paths.

Community

If you want to discuss Cameron, or ask questions about it, simply post questions or ideas here.

Contributing

If you want to help build Cameron, simply follow this to send pull requests here.

TODOs

  • Add support for cartoon avatar
  • Add support for simulation avatar

License

This project is licensed under the MIT License.

License can be found here.

Documentation

Overview

Package cameron implements an avatar generator for Go.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Identicon

func Identicon(data []byte, length, blockLength int) image.Image

Identicon returns an identicon avatar based on the data with the length and blockLength.

Types

This section is empty.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL