go/goreleaser
go/goreleaser
1
0
Fork 0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-01-04 03:11:55 +02:00
Code Issues Releases Activity

Merge pull request #43 from wayneashleyberry/patch-1

Browse Source 
Installation and usage notes
This commit is contained in:
jspc 2017-01-04 09:36:24 +00:00 committed by GitHub
commit e45e47b953
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -5,7 +5,6 @@ Deliver Go binaries as fast and easily as possible.
GoReleaser builds Go binaries for several platforms, creates a github release and then
push a homebrew formulae to a repository. All that wrapped in your favorite CI.
This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code. Please report unacceptable behavior to root@carlosbecker.com.
@ -19,14 +18,19 @@ So, the all-new goreleaser was born.
## Usage
Basically, you need to create a `goreleaser.yml` file in the root of your
repository. A minimal config would look like this:
Create a `goreleaser.yml` file in the root of your repository. A minimal config would look like this:
```yaml
repo: user/repo
binary_name: my-binary
```
You may then run releaser at the root of your repository:
```sh
curl -s https://raw.githubusercontent.com/goreleaser/get/master/latest | bash
```
This will build `main.go` file as `my-binary`, for _Darwin_ and _Linux_,
_x86_64_ and _i386_, packaging the binary, `LICENSE.md` and `README.md`
and publish a new github release in the `user/repo` repository with
@ -85,7 +89,7 @@ after_success:
test -n "$TRAVIS_TAG" && curl -s https://raw.githubusercontent.com/goreleaser/get/master/latest | bash
```
## How the end result looks like
## What the end result looks like
The release on github looks pretty much like this: