1
0
mirror of https://github.com/goreleaser/goreleaser.git synced 2025-02-07 13:31:37 +02:00

Update README.md

Adds installation and usage notes.
This commit is contained in:
Wayne Ashley Berry 2017-01-04 10:21:46 +02:00 committed by GitHub
parent d80a5a2ecf
commit ff64a90be4

View File

@ -19,7 +19,11 @@ So, the all-new goreleaser was born.
## Usage
Basically, you need to create a `goreleaser.yml` file in the root of your
```
go get github.com/goreleaser/releaser
```
Once installed, you need to create a `goreleaser.yml` file in the root of your
repository. A minimal config would look like this:
```yaml
@ -27,6 +31,12 @@ repo: user/repo
binary_name: my-binary
```
You may then run the command at the root of your repository:
```sh
releaser
```
This will build `main.go` file as `my-binary`, for _Darwin_ and _Linux_,
_x86_64_ and _i386_, packaging the binary, `LICENSE.md` and `README.md`
and publish a new github release in the `user/repo` repository with