From 67cce422e80ef675dd08f5645ae3a30130390d99 Mon Sep 17 00:00:00 2001
From: micha <micha@heater.banananet.local>
Date: Fri, 12 Nov 2021 10:08:20 +0100
Subject: [PATCH] added endpoint documentation

---
 README.md | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fb61573..4c73ab8 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,18 @@ micha@rpi:~ cd hr50-api
 micha@rpi:~/hr50-api$ ./bootstrap.sh 
 ```
 
+# API Endpoints
+
+There are two API endpoints available:
+
+## /?cmd=<command>
+
+This method allows you to send commands to the HR50. The commands can be taken from the HR50 operator's manual and do not require the trailing ";"
+
+## /status
+
+This method returns all avalable information in JSON
+
 # Examples
 
 Now you can access the API e.g. with your (HR50 Remote Display)[https://git.qrz.is/clemens/hr50-remote-display]
@@ -57,4 +69,4 @@ Query the status:
 ```
 micha@rpi:~/hr50-api$ curl http://<IP_ADDRESS>:5000/status
 {"AVG":"43","BND":"15M","PEP":"60","PTT":"COR","STA":"RX","SWR":"1.9","TMP":"12C","VLT":"13.7V"}
-```
\ No newline at end of file
+```