1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-03-21 21:07:19 +02:00
goreleaser/docs/000-introduction.md
Bob van Luijt d6b2606ac2 docs: Add examples for installation
It is unclear how to get going with Goreleaser, this might help some new folks.
2017-10-15 17:28:03 -02:00

27 lines
1.1 KiB
Markdown

---
title: Introduction
---
[GoReleaser](https://github.com/goreleaser/goreleaser) is a release automation
tool for Go projects, the goal is to simplify the build, release and
publish steps while providing variant customization options for all steps.
GoReleaser is built for CI tools; you only need to
[download and execute it](#ci_integration) in your build script.
You can [customize](#customization) your release process by
creating a `.goreleaser.yml` file.
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, which would have made the script even more hacky, so I let go of
that and rewrote the whole thing in Go.
## Installing Goreleaser
There are three ways to get going.
1. Install Goreleaser via go get (`goreleaser` command will be globally available) `go get github.com/goreleaser/goreleaser`
2. On a Mac use [Homebrew](https://github.com/goreleaser/homebrew-tap).
3. Install directly [from the binaries](https://github.com/goreleaser/goreleaser/releases/latest).