Skip to content

Commit

Permalink
Fix README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
o1egl committed Feb 13, 2020
1 parent fd0ac73 commit 196a415
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@

![GOvatar image](files/avatars.jpg)

GOvatar is an avatar generation library writen in GO
GOvatar is an avatar generation library written in GO

## Install

To install the library and command line program, use the following:
To install the library and command-line program, use the following:

```
$ go get -u github.com/o1egl/govatar/...
```

[Binary packages](https://github.com/o1egl/govatar/releases) are available for Mac, Linux and Windows.
[Binary packages](https://github.com/o1egl/govatar/releases) are available for Mac, Linux, and Windows.

## Usage

Expand All @@ -37,7 +37,7 @@ Generates avatar and save it to filePath
err := govatar.GenerateFileFromUsername(govatar.MALE, "username", "/path/to/avatar.jpg")
````

Generates avatar and return it as image.Image
Generates an avatar and returns it as an image.Image

```go
img, err := govatar.Generate(govatar.MALE)
Expand All @@ -49,7 +49,7 @@ Generates avatar and return it as image.Image

### Adding new skins

1. Add new skins to background, male/clothes, female/hair and etc...
1. Add new skins to the background, male/clothes, female/hair, etc...
2. Run ``$ make assets`` for building embedded assets.
3. Submit pull request :)

Expand Down

0 comments on commit 196a415

Please sign in to comment.