From 858b5b1d8aa35ef9afa445ea563eec19bb725b18 Mon Sep 17 00:00:00 2001
From: Michael Clemens <git@qrz.is>
Date: Thu, 7 Oct 2021 10:47:24 +0100
Subject: [PATCH] added info to readme

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

diff --git a/README.md b/README.md
index c0d6537..649f911 100644
--- a/README.md
+++ b/README.md
@@ -2,4 +2,52 @@
 
 A small python tool that can be used to query information from the Hardrock-50 amateur radio power amplifier as well as sending commands and therefore to modify settings
 
-![Screenshot](/hr50ctl.jpg)
\ No newline at end of file
+## Features
+
+Queries the followingy data from the Hardrock-50:
+  * Status (RX/TX)
+  * Keying method
+  * Band
+  * Voltage
+  * Peak power of last transmission
+  * Average power of last transmission
+  * SWR
+  * Temperature
+
+Example:
+
++---------+----------+----------+------------+
+| STA: RX | PTT: COR | BND: 20M | VLT: 13.8V |
+| PEP: 58 | AVG: 58  | SWR: 1.2 | TMP: 20C   |
++---------+----------+----------+------------+
+
+Enables the user to alter the following parameters of the Hardrock-50:
+
+  * Keying method (OFF, COR, PTT, QRP)
+  * Band
+  * Initiate tuning process during next transmission
+
+## Usage
+
+```
+USAGE: # ./hr50ctl.py -b <band> -t -k <keying mode>
+
+PARAMETERS:
+   -k: the following keying methods are available:
+       off, cor, ptt, qrp
+       This parameter changes the method how the HR50 will be put into TX mode.
+   -b: the following bands are available:
+       6, 10, 12, 15, 20, 17, 20, 30, 40, 60, 80, 160
+       This parameter changes the band of the HR50
+   -t: no parameter required.
+       This parameters initiates the tuning during the next PTT
+
+EXAMPLES:
+       Change the band to 12m:          # ./hr50ctl.py -b 12
+       Change the keying method to PTT: # ./hr50ctl.py -k ptt
+       Change the band to 6m and tune:  # ./hr50ctl.py -b 6 -t
+```
+
+## Screenshots
+
+![Screenshot](/hr50ctl.jpg)