Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
anthonynsimon committed Jul 30, 2019
1 parent 3e40b2b commit 2a3af03
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,21 @@ The aim of this project is simplicity in use and development over high performan
http://godoc.org/github.com/anthonynsimon/bild


## Install
## CLI usage

bild requires Go version 1.11 or greater.
```bash
go get -u github.com/anthonynsimon/bild/...
Download and compile from sources:
```
go get github.com/anthonynsimon/bild
```

## CLI usage
Or get the pre-compiled binaries for your platform on the [releases page](https://github.com/anthonynsimon/bild/releases)


```bash
# Download and compile from sources
$ go get github.com/anthonynsimon/bild

# See available commands
# Available commands
$ bild

> A collection of parallel image processing algorithms in pure Go
>
> Usage:
Expand All @@ -53,16 +54,17 @@ $ bild
>
> Use "bild [command] --help" for more information about a command.

# Example command
# For example
$ bild effect median --radius 1.5 input.png output.png
```


## Install
## Install package

bild requires Go version 1.11 or greater.

```bash
go get -u github.com/anthonynsimon/bild/...
go get github.com/anthonynsimon/bild/...
```

## Basic package usage example:
Expand Down

0 comments on commit 2a3af03

Please sign in to comment.