From d7dec260cd672da58a68d4e52a0a2686b2bc78ed Mon Sep 17 00:00:00 2001
From: cheetah <git@cheetah.cat>
Date: Fri, 26 Mar 2021 20:02:29 +0000
Subject: [PATCH] extended the readme

---
 README.md | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index e7bac72..80104e8 100644
--- a/README.md
+++ b/README.md
@@ -11,4 +11,29 @@ Features in W.I.P:
 - Still missing a RX path and processing (Message gets passed along every Device Class, which then tries to parse it, if successfull it breaks the processing loop and the Device Class handles decoding+status handling for delivery)
 
 Planned:
-- WebSocket Live Routing Status
\ No newline at end of file
+- WebSocket Live Routing Status
+
+
+
+API Server running on Port `3000`
+
+API Calls:
+
+| GET `/api/message/ack/recv/<id>` - marks a Message as Delivered
+
+| GET `/api/message/status/<id>` - fetches the current Message Data(DeliveryLog, Payload, etc.)
+
+| POST `/api/message/advanced` - Creates a new Message and starts delivering it. HTTP Body is a JSON Object. for example:
+```json
+{
+    "type": "duplex",
+    "routing": {
+        "device": "birdyslim",
+        "connectors": [
+            [ "dummy", "fail" ],
+            [ "pocsag", "133701D" ],
+            [ "dummy", "works" ]
+        ]
+    },
+    "payload": "Testbericht"
+}```
\ No newline at end of file