From cd737f1032d9a3200b48a5a81a70f10836454e1c Mon Sep 17 00:00:00 2001
From: Jorge Bolois <midefos@gmail.com>
Date: Sat, 19 Aug 2023 17:22:48 +0200
Subject: [PATCH] adding readme

---
 README.md  | 17 ++++++++++++++++-
 src/cli.rs |  6 +++---
 2 files changed, 19 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 612e18a..f32561b 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,18 @@
 # temp
 
-Simple personal CLI to gather machine temperatures.
\ No newline at end of file
+Simple personal CLI tool for monitoring temperatures.
+
+You need to have ```nvidia-smi``` and ```lm-sensors``` configured and installed. 
+
+## Usage
+### CPU (Only AMD)
+Display the current temperature in Celsius.
+```
+temp cpu
+```
+### GPU (Only NVIDIA)
+Display the current temperature in Celsius.
+```
+temp gpu
+```
+
diff --git a/src/cli.rs b/src/cli.rs
index b2b9fc1..89c2b7f 100644
--- a/src/cli.rs
+++ b/src/cli.rs
@@ -3,11 +3,11 @@ use structopt::StructOpt;
 #[derive(Debug, StructOpt)]
 #[structopt(
     name = "temp",
-    about = "Simple personal CLI to gather machine temperatures."
+    about = "Simple personal CLI tool for monitoring temperatures."
 )]
 pub enum Arguments {
-    #[structopt(about = "Temperature in Celsius, ONLY AMD")]
+    #[structopt(about = "Temperature in Celsius (Only AMD)")]
     CPU,
-    #[structopt(about = "Temperature in Celsius, ONLY NVIDIA")]
+    #[structopt(about = "Temperature in Celsius (Only NVIDIA)")]
     GPU,
 }