From 0ace1bcad23afcbb492c664698ca90d6f22a0c56 Mon Sep 17 00:00:00 2001 From: Brendan Haines Date: Sat, 14 Sep 2024 13:40:27 -0600 Subject: [PATCH] update README.md --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6889aec..2834f0b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # Goat Monitor -A command line tool for remotely monitoring command execution \ No newline at end of file +A command line tool for remotely monitoring command execution using Gotify. + +Yes, I know Gotify doesn't have "goat" in its name but it sounds like it. + +## Configuration + +```toml +server = "https://gotify.example.com" +app_token = "app_token_from_gotify" + +``` + +## Usage + +``` +goat_monitor --config ./config.toml --retries -1 -- +``` + +The command can be any shell command including arbitrarily many options / arguments. +Note that `--` is often necessary to prevent options within the monitored command from being parsed as options to goat_monitor. \ No newline at end of file