Update docs

pilosus · Sep 3, 2023 · fce5dcd · fce5dcd
1 parent 43af1ec
commit fce5dcd
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,12 @@ file. This change log follows the conventions of
 
 ## [Unreleased]
 
+### Added
+
+- Subcommand `schedule explain <crontab>` to explain a given `crontab`
+  in plain English
+  ([#102](https://github.com/pilosus/dienstplan/issues/102))
+
 ## [1.1.90] - 2023-08-03
 
 ### Added

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -47,7 +47,6 @@ make all
 
 5. Update current tag mentions in `README.md`:
 
-- Docker version
 - Usage examples
 
 6. After release preparation, add a tag with `git tag X.Y.Z`
diff --git a/docs/usage.md b/docs/usage.md
@@ -144,7 +144,7 @@ A meta-command to create, delete or list schedules.
 
 where:
 
-- `<subcommand>` is one of: `[create, delete, list]`
+- `<subcommand>` is one of: `[create, delete, list, explain]`
 - `"<executalbe>"` is a command for a bot to run on schedule
 - `<crontab>` is a crontab file line in
   [vixie-cron](https://man7.org/linux/man-pages/man5/crontab.5.html)
@@ -182,6 +182,20 @@ List all the schedules in the channel:
 @dienstplan schedule list
 ```
 
+#### Explain
+
+Explain a given `crontab` in plain English, e.g.:
+
+```
+@dienstplan schedule explain 0 22 * */2 Mon-Fri
+```
+
+returns:
+
+```
+Crontab `0 22 * */2 Mon-Fri` means the executable will be run at minute 0, past hour 22, on every day of week from Monday through Friday, in every 2nd month
+```
+
 ### Help
 
 Show a help message for the bot: