mirror of
https://github.com/goreleaser/goreleaser.git
synced 2025-01-04 03:11:55 +02:00
Update README.md
This commit is contained in:
parent
ff64a90be4
commit
a8283c0ef0
14
README.md
14
README.md
@ -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,22 +18,17 @@ So, the all-new goreleaser was born.
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
go get github.com/goreleaser/releaser
|
||||
```
|
||||
|
||||
Once installed, 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 the command at the root of your repository:
|
||||
You may then run releaser at the root of your repository:
|
||||
|
||||
```sh
|
||||
releaser
|
||||
curl -s https://raw.githubusercontent.com/goreleaser/get/master/latest | bash
|
||||
```
|
||||
|
||||
This will build `main.go` file as `my-binary`, for _Darwin_ and _Linux_,
|
||||
@ -95,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:
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user