Release 0.1.0

Author: lazyfrosch

.github/workflows/go.yml

@@ -18,3 +18,12 @@ jobs:
 
       - name: Test
         run: go test -v ./...
+
+      - name: Run goreleaser in release mode
+        if: success() && startsWith(github.ref, 'refs/tags/v')
+        uses: goreleaser/goreleaser-action@v2
+        with:
+          version: latest
+          args: release --rm-dist
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -5,6 +5,7 @@
 
 # Binaries for programs and plugins
 /build/
+/dist/
 *.exe
 *.exe~
 *.dll

.goreleaser.yml

@@ -0,0 +1,14 @@
+# See documentation at https://goreleaser.com
+before:
+  hooks:
+    - go mod download
+build:
+  skip: true
+release:
+  github:
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'

README.md

@@ -1,23 +1,56 @@
 go-check
 ========
 
+[![GitHub release (latest by date)](https://img.shields.io/github/v/release/NETWAYS/go-check?label=version)](https://github.com/NETWAYS/go-check/releases)
 [![GoDoc](https://img.shields.io/static/v1?label=godoc&message=reference&color=blue)](https://pkg.go.dev/github.com/NETWAYS/go-check)
 [![Test Status](https://github.com/NETWAYS/go-check/workflows/Go/badge.svg)](https://github.com/NETWAYS/go-check/actions?query=workflow%3AGo)
+![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/NETWAYS/go-check)
 ![GitHub](https://img.shields.io/github/license/NETWAYS/go-check?color=green)
 
 go-check is a library to help with development of monitoring plugins for tools like Icinga.
 
 ## Usage
 
 ```go
-import "github.com/NETWAYS/go-check"
+package main
+
+import (
+	"github.com/NETWAYS/go-check"
+	log "github.com/sirupsen/logrus"
+	"os"
+)
+
+func main() {
+	config := check.NewConfig()
+	config.Name = "check_test"
+	config.Readme = `Test Plugin`
+	config.Version = "1.0.0"
+
+	_ = config.FlagSet.StringP("hostname", "H", "localhost", "Hostname to check")
+
+	os.Args = []string{"check_example", "--help"}
+
+	config.ParseArguments()
+
+	log.Info("test")
+}
 ```
 
-<!-- TODO: add more information and usage examples -->
+See the [documentation on pkg.go.dev](https://pkg.go.dev/github.com/NETWAYS/go-check) for more details and examples.
+
+## Plugins
+
+A few plugins using go-check:
+
+* [check_cloud_aws](https://github.com/NETWAYS/check_cloud_aws)
+* [check_cloud_azure](https://github.com/NETWAYS/check_cloud_azure)
+* [check_cloud_gcp](https://github.com/NETWAYS/check_cloud_gcp)
+* [check_sentinelone](https://github.com/NETWAYS/check_sentinelone)
+* [check_sophos_central](https://github.com/NETWAYS/check_sophos_central)
 
 ## License
 
-Copyright (c) 2020 [NETWAYS GmbH]([email protected])
+Copyright (c) 2020 [NETWAYS GmbH](mailto:[email protected])
 
 This library is distributed under the GPL-2.0 or newer license found in the [COPYING](./COPYING)
 file.