From 619d56861ef3322f6f4cc1e681c10342a52ac2ee Mon Sep 17 00:00:00 2001
From: Oliver Kurz <okurz@suse.de>
Date: Fri, 29 Mar 2024 07:30:35 +0100
Subject: [PATCH] Explain count-fail-ratio in README as well

---
 README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/README.md b/README.md
index cea0c6f..8f98e32 100644
--- a/README.md
+++ b/README.md
@@ -43,6 +43,30 @@ timeout per execution:
 retry -- timeout 10 $cmd
 ```
 
+### count-fail-ratio - simple statistics about retries
+
+Another tool provided is "count-fail-ratio" which can count fails, the fail
+ratio, the failure probability and timing information from repeated command
+calls. Simply call
+
+```
+count-fail-ratio $cmd
+```
+
+to execute `$cmd` automatically multiple times collecting the mentioned
+statistics.
+
+Further options to count-fail-ratio can be specified by runtime variables. For
+example to change the number of runs from the default of 20 set the variable
+"runs" while disabling computing timing information:
+
+```
+runs=100 timing=0 count-fail-ratio $cmd
+```
+
+For the complete list of variables take a look into the script file
+count-fail-ratio itself.
+
 ## Contribute
 
 This project lives in https://github.com/okurz/retry