From 01622ad5631679f686fd8b5fb7f3ea8d07d413b3 Mon Sep 17 00:00:00 2001 From: Carlos Alexandro Becker <caarlos0@users.noreply.github.com> Date: Sun, 20 Aug 2017 22:36:00 -0300 Subject: [PATCH] improved brew docs refs #342 --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 61cba9dfa..c76fa59d3 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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 @@ -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