Update README

Signed-off-by: Nikolaos Karaolidis <nick@karaolidis.com>

.gitignore

@@ -1,21 +0,0 @@
-# If you prefer the allow list template instead of the deny list, see community template:
-# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
-#
-# Binaries for programs and plugins
-*.exe
-*.exe~
-*.dll
-*.so
-*.dylib
-
-# Test binary, built with `go test -c`
-*.test
-
-# Output of the go coverage tool, specifically when used with LiteIDE
-*.out
-
-# Dependency directories (remove the comment below to include it)
-# vendor/
-
-# Go workspace file
-go.work

Makefile

@@ -1,7 +1,5 @@
 .PHONY: build
 
-COMMIT_HASH=$(shell git rev-parse --short HEAD)
-
 build:
-	CGOENABLED=false GOOS=linux GOARCH=amd64 go build -o clickhouse_${COMMIT_HASH}_amd64 cmd/main.go
-	CGOENABLED=false GOOS=linux GOARCH=arm64 go build -o clickhouse_${COMMIT_HASH}_arm64 cmd/main.go
+	CGOENABLED=false GOOS=linux GOARCH=amd64 go build -o telegraf-clickhouse-plugin-linux-amd64 cmd/main.go
+	CGOENABLED=false GOOS=linux GOARCH=arm64 go build -o telegraf-clickhouse-plugin-linux-arm64 cmd/main.go

README.md

@@ -4,6 +4,22 @@ The ClickHouse output plugin saves Telegraf metric data to a ClickHouse database
 
 The plugin uses Golang's generic "database/sql" interface and third party drivers.
 
+## Build
+
+Dependencies:
+
+* [Go](https://golang.org/doc/install)
+* [Make](https://www.gnu.org/software/make/)
+
+To build the plugin, run `make` in the root directory of the project.
+
+Alternatively, you can build the plugin using Docker:
+
+```bash
+docker run --rm -v $(pwd):/telegraf -w /telegraf -e CGOENABLED=false -e GOOS=linux -e GOARCH=amd64 golang go build -o telegraf-clickhouse-plugin-linux-amd64 cmd/main.go
+docker run --rm -v $(pwd):/telegraf -w /telegraf -e CGOENABLED=false -e GOOS=linux -e GOARCH=arm64 golang go build -o telegraf-clickhouse-plugin-linux-arm64 cmd/main.go
+```
+
 ## Getting started
 
 To use the plugin, set the data source name (DSN). The user account must have privileges to insert rows and create tables.

cmd/main.go

@@ -6,7 +6,7 @@ import (
 	"os"
 	"time"
 
-	_ "github.com/karaolidis/telegraf-clickhouse-plugin/plugins/outputs/clickhouse"
+	_ "git.karaolidis.com/karaolidis/telegraf-clickhouse-plugin/plugins/outputs/clickhouse"
 
 	"github.com/influxdata/telegraf/plugins/common/shim"
 )

go.mod

@@ -1,4 +1,4 @@
-module github.com/karaolidis/telegraf-clickhouse-plugin
+module git.karaolidis.com/karaolidis/telegraf-clickhouse-plugin
 
 go 1.20