From 313f3451d83fbf0e284b734cd8110a7c1ed57e13 Mon Sep 17 00:00:00 2001 From: Jesse Portnoy Date: Wed, 23 Aug 2023 18:39:12 +0100 Subject: [PATCH] README --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 118559d..3548fab 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ By using it as a template when creating new projects, you will gain: * GO docs * GO report card -## Contents +## Configuration files - [.pre-commit-config.yaml](.pre-commit-config.yaml): a set of pre-commit hooks relevant to GO code - [.goreleaser.yaml](.goreleaser.yaml): [GoReleaser](https://goreleaser.com/quick-start) configuration file - [.github/workflows/go.yml](.github/workflows/go.yml): GH action for post push and pull request testing @@ -121,13 +121,13 @@ With GoReleaser, you can: This repo includes a [basic GoReleaser config](.goreleaser.yaml) that will produce binaries for Linux, Darwin (what people refer to as MacOS and shouldn't), FreeBSD and NetBSD. You can tweak it as you please but one necessary change is in [line 21](https://github.com/jessp01/grt/blob/master/.goreleaser.yaml#L21) where `main` should point to your entry -file. Also included, is [.github/workflows/release.yml](.github/workflows/release.yml), a GH action to trigger upon tag creation. This file will work out of the box. +file. Also included, is [.github/workflows/release.yml](.github/workflows/release.yml), a GH action to trigger upon tag creation. This file will work out of the box but of course, you may edit it to your liking. -### Contributing +## Contributing Contributions are, of course, welcome. Please submit a pull request. -### License +## License Code is under AGPLv3 License.