From 931ad5164242ba26ce231536a7f52a9875722927 Mon Sep 17 00:00:00 2001 From: Noccy Date: Thu, 10 Mar 2022 01:52:49 +0000 Subject: [PATCH] Update 'Usage' --- Usage.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/Usage.md b/Usage.md index 5d08b7b..6526717 100644 --- a/Usage.md +++ b/Usage.md @@ -1 +1,17 @@ -Welcome to the Wiki. \ No newline at end of file +## Basic usage + +Using Fresh is as simple as falling off a log. Just run it while in a directory that contains a `docker-compose.yml` file, and Fresh will go and check for updates to any registries you have authenticated against. This means it currently can't be used to check images from dockerhub, but it works great for private registries. + +### Slack/Mattermost Webhooks + +Fresh can invoke a Slack-compatible webhook to notify before anything is actually updated. To do this, use the `--slack` flag followed by the webhook URL + +### Script hooks + +You can specify a script to run after an update by using the `--after` flag. + +## Scheduled run + +### Using cron + +### Using Systemd