From 87a262edff6d847fa71342ad76ee5c694608b3ff Mon Sep 17 00:00:00 2001
From: Stefan Strigler <stefan.strigler@emqx.io>
Date: Thu, 30 Mar 2023 16:53:27 +0200
Subject: [PATCH] docs: add README for EMQX Dashboard

---
 apps/emqx_dashboard/README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/apps/emqx_dashboard/README.md b/apps/emqx_dashboard/README.md
index 7466b5afe..88c714aca 100644
--- a/apps/emqx_dashboard/README.md
+++ b/apps/emqx_dashboard/README.md
@@ -1 +1,17 @@
-# TODO: Doc
+# EMQX Dashboard
+
+This application provides access to the EMQX Dashboard as well as the actual,
+underlying REST API itself and provides authorization to protect against
+unauthorized access. Furthermore it connects middleware adding CORS headers.
+Last but not least it exposes the `/status` endpoint needed for healtcheck
+monitoring.
+
+## Implementation details
+
+This implementation is based on `minirest`, and relies on `hoconsc` to provide an
+OpenAPI spec for `swagger`.
+
+Note, at this point EMQX Dashboard itself is an independent frontend project and
+is integrated through a static file handler. This code here is responsible to
+provide an HTTP(S) server to give access to it and its underlying API calls.
+This includes user management and login for the frontend.