avatars/README.md

21 lines
457 B
Markdown
Raw Normal View History

2021-02-02 03:41:25 +03:00
# Golang port of DiceBear Avatars, which in turn were inspired by 8biticon avatars
2021-02-02 04:43:59 +03:00
## Usage
import `codeberg.org/Codeberg/avatars`
and use `string svg = avatars.MakeAvatar(seed)`
## Build & Use Example
2021-02-02 03:41:25 +03:00
```shell
2021-02-02 04:43:59 +03:00
# will build the binary
go build -o avatars example/main.go
2021-02-02 03:41:25 +03:00
# Create a random avatar and write it to /tmp/avatar.svg
2021-02-02 04:43:59 +03:00
./avatars my-special-seed-string > /tmp/avatar.svg
2021-02-02 03:41:25 +03:00
# Open SVG file with default image viewer
xdg-open /tmp/avatar.svg
```