1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-04-11 11:42:15 +02:00

Add documentation link

This commit is contained in:
Mohamed Gharsallah 2017-01-21 15:34:40 +01:00
parent d88947c238
commit 1a25792e6f

View File

@ -11,7 +11,7 @@ By participating, you are expected to uphold this code. Please report unacceptab
[![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)
[![Go Report Card](https://goreportcard.com/badge/github.com/goreleaser/goreleaser?style=flat-square)](https://goreportcard.com/report/github.com/goreleaser/goreleaser)
[![Go Report Card](https://goreportcard.com/badge/github.com/goreleaser/goreleaser?style=flat-square)](https://goreportcard.com/report/github.com/goreleaser/goreleaser)
[![Powered By: GoReleaser](https://img.shields.io/badge/powered%20by-goreleaser-green.svg?style=flat-square)](https://github.com/goreleaser)
## Why?
@ -22,6 +22,10 @@ Homebrew.
So, the all-new GoReleaser was born.
## Documentation
For Documentation, visit the [GoReleaser website](https://goreleaser.github.io/documentation/) or our GitHub [here](/docs).
## Usage
- You need to export a `GITHUB_TOKEN` environment variable with
@ -47,7 +51,7 @@ Of course, all this can be customized!
For customization create a `goreleaser.yml` file in the root of your repository.
A complete and commented example can be found [here](/goreleaser.example.yml).
A complete and commented example can be found in the [documentation](/docs/#release-customization).
You can also check the [goreleaser.yml](/goreleaser.yml) used by GoReleaser
itself.