From 9504d5dc5abf116eaba9afaea70e86d0d35f63ba Mon Sep 17 00:00:00 2001 From: Tobias Klug Date: Thu, 29 Aug 2024 15:50:26 +0200 Subject: [PATCH] Update readme --- README.md | 31 +++++++++++++++++-------------- 1 file changed, 17 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 2ea79c5..e117d89 100644 --- a/README.md +++ b/README.md @@ -19,24 +19,27 @@ tar -xvzf strikes-0.0.1-alpha-x86_64-unknown-linux-musl.tar.gz -C -``` +Simple CLI tool to track and assign strikes -- List all strikes -```bash -strikes ls -``` +Usage: strikes [OPTIONS] [COMMAND] -- Clear all strikes -```bash -strikes clear -``` +Commands: + strike Add a strike + ls List all strikes + clear Clear strikes + check-health Check health of the client + help Print this message or the help of the given subcommand(s) -- Help -```bash -strikes --help +Options: + -c, --config-path + Specify the path to the configuration file + + -h, --help + Print help (see a summary with '-h') + + -V, --version + Print version ``` ## Use with a remote server