Skip to content

Commit

Permalink
Readme changes
Browse files Browse the repository at this point in the history
  • Loading branch information
o1egl committed Mar 2, 2021
1 parent d691d06 commit 97df944
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 5 deletions.
1 change: 0 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ ext = $(word 3, $(temp))
VERSION := $(shell git describe --always --abbrev=6 --tags)

.PHONY: build

build: clean $(PLATFORMS);

clean:
Expand Down
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 97df944

Please sign in to comment.