1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-02-09 13:36:56 +02:00

Merge pull request #209 from goreleaser/readme

a better looking readme, maybe
This commit is contained in:
Carlos Alexandro Becker 2017-04-24 13:02:04 -03:00 committed by GitHub
commit 875b9dff1f

View File

@ -1,6 +1,37 @@
# GoReleaser
<p align="center">
<img alt="GoReleaser Logo" src="https://avatars2.githubusercontent.com/u/24697112?v=3&s=200" height="140" />
<h3 align="center">GoReleaser</h3>
<p align="center">Deliver Go binaries as fast and easily as possible.</p>
<p align="center">
<a href="https://github.com/goreleaser/goreleaser/releases/latest">
<img alt="Release" src="https://img.shields.io/github/release/goreleaser/goreleaser.svg?style=flat-square">
</a>
<a href="/goreleaser/goreleaser/blob/master/LICENSE.md">
<img alt="Software License" src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square">
</a>
<a href="https://travis-ci.org/goreleaser/goreleaser">
<img alt="Travis" src="https://img.shields.io/travis/goreleaser/goreleaser.svg?style=flat-square">
</a>
<a href="https://codecov.io/gh/goreleaser/goreleaser">
<img alt="Codecov branch" src="https://img.shields.io/codecov/c/github/goreleaser/goreleaser/master.svg?style=flat-square">
</a>
<a href="https://goreportcard.com/report/github.com/goreleaser/goreleaser">
<img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/goreleaser/goreleaser?style=flat-square">
</a>
<a href="http://godoc.org/github.com/goreleaser/goreleaser">
<img alt="Go Doc" src="https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square">
</a>
<a href="https://saythanks.io/to/caarlos0">
<img alt="SayThanks.io" src="https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg?style=flat-square">
</a>
<a href="https://github.com/goreleaser">
<img alt="Powered By: GoReleaser" src="https://img.shields.io/badge/powered%20by-goreleaser-green.svg?style=flat-square">
</a>
</p>
</p>
---
<img src="https://avatars2.githubusercontent.com/u/24697112?v=3&s=200" alt="goreleaser" align="right" />
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.
@ -8,15 +39,6 @@ pushes a Homebrew formula 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.
We appreciate your contribution. Please refer to our [contributing guidelines](CONTRIBUTING.md) for further information.
[![Release](https://img.shields.io/github/release/goreleaser/goreleaser.svg?style=flat-square)](https://github.com/goreleaser/goreleaser/releases/latest)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
[![Travis](https://img.shields.io/travis/goreleaser/goreleaser.svg?style=flat-square)](https://travis-ci.org/goreleaser/goreleaser)
[![Codecov branch](https://img.shields.io/codecov/c/github/goreleaser/goreleaser/master.svg?style=flat-square)](https://codecov.io/gh/goreleaser/goreleaser)
[![Go Report Card](https://goreportcard.com/badge/github.com/goreleaser/goreleaser?style=flat-square)](https://goreportcard.com/report/github.com/goreleaser/goreleaser)
[![Go Doc](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](http://godoc.org/github.com/goreleaser/goreleaser)
[![SayThanks.io](https://img.shields.io/badge/SayThanks.io-%E2%98%BC-1EAEDB.svg?style=flat-square)](https://saythanks.io/to/caarlos0)
[![Powered By: GoReleaser](https://img.shields.io/badge/powered%20by-goreleaser-green.svg?style=flat-square)](https://github.com/goreleaser)
For questions join the [#goreleaser](https://gophers.slack.com/messages/goreleaser/) channel in the [Gophers Slack](https://invite.slack.golangbridge.org/).
# Table of contents
@ -37,8 +59,6 @@ We are also working on integrating with package managers, we currently support H
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.
_So, the all-new GoReleaser was born._
## Quick start
In this example we will build, archive and release a Golang project.