avatar

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 10 Open GitHub ↗

Create square avatars with initials

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

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")
}

```
[![Example](https://raw.githubusercontent.com/ae0000/avatar/master/ae.png)](https://raw.githubusercontent.com/ae0000/avatar/master/ae.png)

You can pass in a single character as well

```
// Single initial as well..
avatar.ToDisk("Jet", "../j.png")
```
[![Example](https://raw.githubusercontent.com/ae0000/avatar/master/j.png)](https://raw.githubusercontent.com/ae0000/avatar/master/j.png)

HTTP example
------------

Using [go-chi](https://github.com/go-chi/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
----

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

avatar

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README