From ec8b8109bd0a2f21b962788b9a660b8838ca1e96 Mon Sep 17 00:00:00 2001
From: Ilya Zlobintsev <ilya.zl@protonmail.com>
Date: Sun, 28 Feb 2021 07:59:00 +0200
Subject: [PATCH] Document the CLI

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

diff --git a/README.md b/README.md
index 587b4b78..b0143b21 100644
--- a/README.md
+++ b/README.md
@@ -45,3 +45,52 @@ sudo systemctl enable --now lactd
 You can now use the application.
 
 Note: only members of the group `wheel` can change settings.
+
+# CLI
+
+There is also a cli available.
+
+- Getting basic information: 
+
+    `lact-cli info`
+
+    Example output:
+
+    ```
+    GPU Model: Radeon RX 570 Pulse 4GB
+    GPU Vendor: Advanced Micro Devices, Inc. [AMD/ATI]
+    Driver in use: amdgpu
+    VBIOS Version: 113-1E3871U-O4C
+    VRAM Size: 4096
+    Link Speed: 8.0 GT/s PCIe
+    ```
+- Getting current GPU stats:
+
+    `lact-cli metrics`
+
+    Example output:
+
+    ```
+    VRAM Usage: 545/4096MiB
+    Temperature: 46°C
+    Fan Speed: 785/3200RPM
+    GPU Clock: 783MHz
+    GPU Voltage: 0.975V
+    VRAM Clock: 1750MHz
+    Power Usage: 38/155W
+    ```
+    
+- Showing the current fan curve: 
+
+    `lact-cli curve status`
+    
+    Example output:
+
+    ```
+    Fan curve:
+    20C°: 0%
+    40C°: 0%
+    60C°: 50%
+    80C°: 88%
+    100C°: 100%
+    ```
\ No newline at end of file