From 9199c05173b8021cfdc787761b8fa27dbd83f6b7 Mon Sep 17 00:00:00 2001 From: Patrick MARIE Date: Sun, 21 Feb 2021 22:08:45 +0100 Subject: [PATCH] Updating documentation. --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 43 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1bf1772..660d651 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,12 @@ USAGE: bgutil-rs SUBCOMMANDS: - help Prints this message or the help of the given subcommand(s) - info Information about a metric - list List metrics with given pattern - read Read a metric contents + delete Delete metric(s) + help Prints this message or the help of the given subcommand(s) + info Information about a metric + list List metrics with given pattern + read Read a metric contents + write Write a metric and its value ``` ### Info @@ -107,6 +109,43 @@ m observability.testaroo.go_memstats_mallocs_total {"aggregator": "average", "re ... ``` + +### Write + +```sh +$ cargo run -- write --help +bgutil-rs-write +Write a metric and its value + +USAGE: + bgutil-rs write [OPTIONS] + +OPTIONS: + --retention + -t, --timestamp + +ARGS: + + +``` + +### Delete + +```sh +$ cargo run -- delete --help +bgutil-rs-delete +Delete metric(s) + +USAGE: + bgutil-rs delete [FLAGS] + +FLAGS: + --recursive + +ARGS: + +``` + ## Todo * command: read