From 04227e950b90cf44e1d2beb283505f3503277901 Mon Sep 17 00:00:00 2001 From: Carlos Alexandro Becker <caarlos0@gmail.com> Date: Thu, 12 Jan 2017 19:51:57 -0200 Subject: [PATCH] document GITHUB_TOKEN closes #39 --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d6d53b3f8..794829163 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,8 @@ So, the all-new goreleaser was born. ## Usage -Create a `goreleaser.yml` file in the root of your repository. A minimal config would look like this: +Create a `goreleaser.yml` file in the root of your repository. A minimal config +would look like this: ```yaml repo: user/repo @@ -31,6 +32,10 @@ You may then run releaser at the root of your repository: curl -s https://raw.githubusercontent.com/goreleaser/get/master/latest | bash ``` +For that to work, you need to export a `GITHUB_TOKEN` environment variable with +the `repo` scope selected. You can create one +[here](https://github.com/settings/tokens/new). + This will build `main.go` as `my-binary`, for `Darwin` and `Linux` (`amd64` and `i386`), archive the binary and common files as `.tar.gz`, and finally, publish a new github release in the `user/repo` repository with