Skip to content

Commit

Permalink
improved brew docs
Browse files Browse the repository at this point in the history
refs #342
  • Loading branch information
caarlos0 committed Aug 21, 2017
1 parent 429d42b commit 01622ad
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@


GoReleaser builds Go binaries for several platforms, creates a GitHub release and then
pushes a Homebrew formula to a repository. All that wrapped in your favorite CI.
pushes a Homebrew formula to a tap 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.
We appreciate your contribution. Please refer to our [contributing guidelines](CONTRIBUTING.md) for further information.
Expand All @@ -39,9 +39,10 @@ GoReleaser is a release automation tool for Golang projects, the goal is to simp

GoReleaser is built for CI tools; you only need to [download and execute it](#integration-with-ci) in your build script.
You can [customize](#release-customization) your release process by createing a `.goreleaser.yml` file.
We are also working on integrating with package managers, we currently support Homebrew.
We are also working on integrating with package managers, we currently support Home
.

The idea started with a [simple shell script](https://github.com/goreleaser/old-go-releaser), but it quickly became more complex and I also wanted to publish binaries via Homebrew.
The idea started with a [simple shell script](https://github.com/goreleaser/old-go-releaser), but it quickly became more complex and I also wanted to publish binaries via Homebrew taps.

## Quick start

Expand Down Expand Up @@ -413,6 +414,10 @@ class Program < Formula
end
```

Note that GoReleaser does not yet generate a valid homebrew-core formula. The generated formulas
are meant to be published as [homebrew taps](https://docs.brew.sh/brew-tap.html), not in any
of the official homebrew repositories.

### FPM build customization

GoReleaser can be wired to [fpm]() to generate `.deb`, `.rpm` and other archives. Check its
Expand Down

0 comments on commit 01622ad

Please sign in to comment.