From 97df944b03697804d639daecab8bd17941c9720c Mon Sep 17 00:00:00 2001 From: Oleg Lobanov Date: Tue, 2 Mar 2021 11:27:28 +0100 Subject: [PATCH] Readme changes --- Makefile | 1 - README.md | 27 +++++++++++++++++++++++---- 2 files changed, 23 insertions(+), 5 deletions(-) diff --git a/Makefile b/Makefile index 552f7bc..69e0cc9 100644 --- a/Makefile +++ b/Makefile @@ -7,7 +7,6 @@ ext = $(word 3, $(temp)) VERSION := $(shell git describe --always --abbrev=6 --tags) .PHONY: build - build: clean $(PLATFORMS); clean: diff --git a/README.md b/README.md index ccf2d08..c3ca37a 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,35 @@ GOvatar is an avatar generation library written in GO +--- + +#### Notes +1. From release v0.4.0 onward, the minimal supported golang version is 1.16. + +--- + ## Install -To install the library and command-line program, use the following: +### Brew + +``` +$ brew tap o1egl/tap +$ brew install govatar +``` + +### Docker + +``` +$ docker pull o1egl/govatar +``` + +### From source ``` $ go get -u github.com/o1egl/govatar/... ``` -[Binary packages](https://github.com/o1egl/govatar/releases) are available for Mac, Linux, and Windows. +Prebuilt [binary packages](https://github.com/o1egl/govatar/releases) are available for Mac, Linux, and Windows. ## Usage @@ -50,8 +70,7 @@ Generates an avatar and returns it as an image.Image ### Adding new skins 1. Add new skins to the background, male/clothes, female/hair, etc... -2. Run ``$ make assets`` for building embedded assets. -3. Submit pull request :) +2. Submit pull request :) ### Submitting a Pull Request