about summary refs log tree commit diff
path: root/cmd/slocalc/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'cmd/slocalc/README.md')
-rw-r--r--cmd/slocalc/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/cmd/slocalc/README.md b/cmd/slocalc/README.md
new file mode 100644
index 0000000..660b653
--- /dev/null
+++ b/cmd/slocalc/README.md
@@ -0,0 +1,20 @@
+# slocalc
+
+A simple SLO calculator for the command line.
+
+## Usage
+
+```bash
+slocalc <availability>
+```
+
+## Example
+
+```bash
+% slocalc 99.9
+daily    : 0 days, 0 hours, 0 minutes, 4 seconds
+weekly   : 0 days, 0 hours, 0 minutes, 30 seconds
+monthly  : 0 days, 0 hours, 2 minutes, 9 seconds
+quarterly: 0 days, 0 hours, 6 minutes, 28 seconds
+yearly   : 0 days, 0 hours, 26 minutes, 16 seconds
+```