From baadf876dcdd10529a4408a2de9d81b949404907 Mon Sep 17 00:00:00 2001
From: Jan Dittberner <jan@dittberner.info>
Date: Thu, 26 Sep 2024 17:32:27 +0200
Subject: [PATCH] Improve documentation

---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/README.md b/README.md
index bd5e5ef..16e70fd 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,43 @@ implementation](https://github.com/linuxmail/icinga2-matrix_notification) which
 has been built on the [E-Mail notifications by
 sysadmama](https://github.com/sysadmama).
 
+## Building the binaries
+
+You can build binaries via `go build` or using [Goreleaser](https://goreleaser.com/intro/).
+
+```shell
+go build ./cmd/matrix-host-notification
+go build ./cmd/matrix-service-notification
+```
+
+```shell
+goreleaser build
+```
+
+You may have to add the `--snapshot` and `--clean` command line flags to `goreleaser` if
+you are not building a tagged version
+or have local modifications.
+
+## Code quality checks
+
+The repository contains a configuration for [golangci-lint](https://golangci-lint.run/). You can
+run the linting via
+
+```shell
+golangci-lint run
+```
+
+## Usage
+
+Copy the notification command binaries to the Icinga 2 systems you want to
+send notifications from.
+
+Use the configuration examples as a base for your own NotificationCommand and
+Notification object definitions. See
+[Notification](https://icinga.com/docs/icinga-2/latest/doc/09-object-types/#notification) and
+[NotificationCommand](https://icinga.com/docs/icinga-2/latest/doc/09-object-types/#notificationcommand)
+in the Icinga 2 documentation for reference.
+
 ## License
 
 Icinga2 Matrix notifications