From 0a05adb1001af2e4b84dfb606d3d5782704cf195 Mon Sep 17 00:00:00 2001 From: Nguyễn Gia Phong Date: Thu, 22 May 2025 14:52:10 +0900 Subject: Provide some structure for the README --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 8f89b5e..c7d67e8 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ that are about to expire and provides an Atom feed for notification. ## Usage +### Expiration checking + ```console $ scadere check --help Usage: scadere check [-h] [-d DAYS] [-o PATH] HOST[:PORT] [HOST[:PORT] ...] @@ -18,6 +20,10 @@ Options: output file (default to stdout) ``` +It is recommended to run `scadere check` as a cron job. + +### Expiration notification + ```console $ scadere listen --help Usage: scadere listen [-h] INPUT URL [[HOST][:PORT]] -- cgit 1.4.1